---
id: public-api.endpoints
title: API Endpoint Reference
summary: Locate canonical organization-scoped operations and their request/response schemas.
kind: api
product_area: public_api
status: stable
updated: 2026-10-31
canonical: /docs/public-api/endpoints
---

# API Endpoint Reference

## Definition

Use this catalog to locate an operation. The [OpenAPI YAML](https://api.teammately.ai/v1/openapi.yaml) and [JSON](https://api.teammately.ai/v1/openapi.json) supply its full body, query, response and security schemas. [Authentication](/docs/public-api/authentication) is operation-specific; native CLI delegation does not authorize every resource below.

## Projects

These paths follow `/v1/organizations/{organizationKey}`:

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/projects` | List Projects |
| `POST` | `/projects` | Create a Project |
| `GET` | `/projects/{projectId}` | Read a Project |
| `PATCH` | `/projects/{projectId}` | Update a Project |

## Dimensions and terms

These and the following project operations follow `/v1/organizations/{organizationKey}/projects/{projectId}`. Keep the API's `dimensions`/`terms` wire names when working with the corresponding product coverage concepts.

| Method | Path | Operation |
| --- | --- | --- |
| `GET`, `POST` | `/dimensions` | List/create dimensions |
| `GET`, `PATCH` | `/dimensions/{dimensionId}` | Read/update a dimension |
| `GET`, `POST` | `/dimensions/{dimensionId}/terms` | List/create terms |
| `GET`, `PATCH` | `/dimensions/{dimensionId}/terms/{termId}` | Read/update a term |

## Dataset records and views

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/datasets/views` | List views |
| `GET` | `/datasets/views/{viewId}` | Read a view |
| `GET` | `/datasets/views/{viewId}/records` | Read view records |
| `GET` | `/datasets/views/{viewId}/representation` | Read representation |
| `GET` | `/datasets/records` | List records |
| `GET` | `/datasets/records/{recordId}` | Read a record |
| `GET` | `/datasets/records/{recordId}/versions` | List record versions |
| `POST` | `/datasets/upload` | Upload records using its operation schema |

## Cases and Fieldloop

| Method | Path | Guide |
| --- | --- | --- |
| `GET` | `/cases`, `/cases/{caseId}` | [Case reads](/docs/public-api/cases) |
| `PUT` | `/cases/{caseId}/reference-result` | [Reference responses](/docs/public-api/cases#write-a-reference-response) |
| `POST` | `/cases/reference-results` | Batch reference responses |
| `POST` | `/cases/imports` | [Multipart imports](/docs/public-api/case-imports) |
| `GET` | `/cases/imports/{importId}` | Import status |
| `POST` | `/fieldloop/sources/{sourceId}/batches` | [Fieldloop submission](/docs/public-api/fieldloop) |
| `GET` | `/fieldloop/sources/{sourceId}/batches/{batchId}` | Fieldloop receipt |

Case imports and batch reference writes reject repeated idempotency keys rather than replaying receipts. Use their [specific recovery rules](/docs/public-api/conventions#recover-without-duplicating-work).

## Benchmark context and external outputs

The following paths continue beneath `/benchmarks/{benchmarkId}/versions/{benchmarkVersionId}`. `run-groups` identifies the product Run; a nested child `runId` identifies a Trial.

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/version-context` | Pinned summary/Cases/Policies/Rubrics |
| `GET` | `/case-manifest` | Frozen execution population |
| `GET` | `/run-groups` | Existing groups and submission context |
| `POST` | `/run-groups` | Create a group/first child with actual results |
| `POST` | `/run-groups/{groupId}/runs` | Create an additional Trial |
| `GET` | `/run-groups/{groupId}/runs/{runId}` | Import state |
| `GET`, `POST` | `/run-groups/{groupId}/runs/{runId}/results` | Read/append submitted outputs |
| `POST` | `/run-groups/{groupId}/runs/{runId}/complete` | Freeze outputs and request evaluation |

Follow [External Evaluation Outputs](/docs/public-api/evaluation-outputs) for the complete lifecycle and immutable-response rules.

## Managed execution and assessment

| Method | Path | Operation |
| --- | --- | --- |
| `GET` | `/managed-run-profile` | Current execution policy/token |
| `POST` | `/harness-submissions` | Save exact source |
| `POST` | `/harness-runtime-preparations` | Request runtime preparation |
| `POST` | `/managed-runs` | Request managed execution |
| `GET` | `/runs/{runId}` | Individual execution/progress |
| `GET` | `/runs/{runId}/evaluation-context` | Bounded context and observations |
| `GET` | `/runs/{runId}/evaluation-results` | Paged judgments |
| `GET` | `/runs/{runId}/evaluation-instructions` | Evaluation procedure |
| `GET` | `/comparison/{runId}/summary` | Explicit baseline/target summary |
| `GET` | `/comparison/{runId}/cases` | Paged Case changes |

See [Managed Execution](/docs/public-api/managed-execution) and [Results](/docs/public-api/benchmark-results) for sequence, filters and interpretation.
