Skip to main content

Command-line tool for running human evaluation surveys with Datapoint AI

Project description

Datapoint CLI

Run human-evaluation surveys from your terminal: A/B preference tests, ratings, rankings, and classification — on text, images, audio, and video. Get real human opinions, then read aggregated results back in your shell.

License: MIT Powered by Datapoint AI

datapoint is a command-line client for Datapoint AI. It wraps the same public API used by the editor integrations, so you can design a survey, launch it to a panel of real humans, and pick up results a few minutes later — without leaving the terminal.

Install

pip install datapoint-ai
# or, run without installing:
uvx --from datapoint-ai datapoint --help
# or, isolated install:
pipx install datapoint-ai

The PyPI package is datapoint-ai; the installed command is datapoint. Requires Python 3.10+.

Quick start

datapoint login                              # opens your browser to sign in
datapoint balance

datapoint media upload ./logo-a.png ./logo-b.png
datapoint survey plan "Compare logo A (dp://media/abc.png) and \
    logo B (dp://media/def.png). Target: software engineers." \
    --max-responses 20 --save plan.json
datapoint survey create plan.json            # shows cost, asks to confirm
datapoint survey status JOB_ID
datapoint survey responses JOB_ID

Commands

datapoint login | logout | whoami
datapoint balance
datapoint subscription
datapoint credits buy [PRODUCT_ID] [--open]
datapoint billing portal [--open]
datapoint media upload FILES...
datapoint survey plan DESCRIPTION [--max-responses N] [--save FILE]
datapoint survey create PLAN_FILE [--yes]
datapoint survey list
datapoint survey status JOB_ID [--results]
datapoint survey responses JOB_ID [--page N] [--per-page N]
                                  [--include-abandoned] [--include-in-progress]
datapoint survey pause | resume | retry JOB_ID
datapoint survey cancel JOB_ID [--yes]
datapoint survey report JOB_ID
datapoint filters [--country C] [--region R] [--city K] [--postal P]
                  [--field F] [--offset N] [--limit N]

Every read command supports --json for machine-readable output you can pipe into jq or another tool.

How survey create works

survey create reserves credits and dispatches paid human work within seconds — there is no draft or staging state. So it prints the plan summary and cost and asks you to confirm before launching:

$ datapoint survey create plan.json
Survey: Logo memorability A vs B
Task type: comparison
Datapoints: 1
Responses per datapoint: 20
Estimated cost: 100 credits

This reserves 100 credits and dispatches paid human work. Continue? [y/N]:

Pass --yes to skip the prompt in scripts (after a human has reviewed the plan).

Configuration

Variable Description
DATAPOINT_API_KEY API key (overrides saved config).
DATAPOINT_BASE_URL API base URL (default https://api.trydatapoint.com/data-labelling/v1).

Your API key is saved to ~/.config/datapoint/config.json (%APPDATA%\datapoint\config.json on Windows) with owner-only permissions. The Datapoint editor integration reads the same file, so logging in once authenticates both.

Exit codes

Code Meaning
0 Success
1 Generic error
2 Not authenticated
3 Insufficient credits
4 Rate limited

Set DATAPOINT_DEBUG=1 to print full tracebacks on unexpected errors.

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

datapoint_ai-0.1.0.tar.gz (41.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

datapoint_ai-0.1.0-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file datapoint_ai-0.1.0.tar.gz.

File metadata

  • Download URL: datapoint_ai-0.1.0.tar.gz
  • Upload date:
  • Size: 41.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for datapoint_ai-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2cfdc71e089e3bc5c9651c7b65c70b89b05411ce3c96d0cea849a04b8acfecf9
MD5 89edcd439f2157aea2c8a8f720f25558
BLAKE2b-256 e9b1c0e8036f3559ed8f27e36d3f5516bc1184b851981b7a96a492f0f334c07e

See more details on using hashes here.

File details

Details for the file datapoint_ai-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: datapoint_ai-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for datapoint_ai-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b98e251765cf81b4e777a222df7709fd13f94574c69b1071f4767efe02f8c45
MD5 f7102ab89e5b8e0553d1aaa335658d3d
BLAKE2b-256 e1d54856279109389ecbb0f0f47e98a256e4a4d3fc8717927166f3053654dc39

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page