Public API
Definition
The customer gateway uses the base https://api.teammately.ai/v1 and organization-scoped resources beneath /organizations/{organizationKey}/projects/{projectId}.
Start with Your First API Request. Use REST for direct request control, SDKs for application ingestion, or the CLI for coding-agent and local-file workflows.
Contract families
The endpoint catalog includes Projects, dimensions/terms and dataset operations as well as the workflow families below.
| Family | Operations and guide |
|---|---|
| Cases | List/detail and single/batch reference responses |
| Case imports | Multipart import and status |
| Fieldloop | Batch submission and receipts |
| External outputs | Frozen manifest, real first results, batches and completion |
| Managed execution | Source submission, runtime preparation and admission |
| Results | Pinned context, individual Trial results and comparisons |
OpenAPI and conventions
The OpenAPI YAML and OpenAPI JSON describe request fields, response schemas and per-operation authentication. These guides explain operation sequences and asynchronous outcomes.
Read Authentication and Conventions before writing. Envelopes and pagination vary by resource. Supply credentials through the host's secret mechanism and use identifiers from Teammately.
Use the request panel's language selector to switch between equivalent cURL, Python, TypeScript and Go examples. Copy copies the selected language. JSON request bodies and HTTP signatures are shown separately.
These are direct HTTP examples, not SDK method declarations. Python uses its standard library; TypeScript uses Node.js 22+ built-in fetch and file APIs; Go uses its standard library. Application SDKs describe the resources each Teammately library exposes.
The quickstart exports the nonsecret PROJECT_URL and BENCHMARK_URL values. Export each example's additional identifiers and logical-command keys before running it. Supply TEAMMATELY_API_KEY through your approved secret environment. Keep original body files and request identity when following the operation's recovery rules.
Runs, Trials and wire names
The product calls an external cohort a Run and child executions Trials. API paths retain run-groups for the cohort and runs for an individual child. Keep both returned IDs. Assessment and comparison reads use the child runId, not the group ID.