REST Endpoints

Implemented Endpoints

Method	Path	Required scope
`GET`	`/api/v1/projects`	`api:projects:read`
`POST`	`/api/v1/projects`	`api:projects:write`
`GET`	`/api/v1/projects/:id`	`api:projects:read`
`PATCH`	`/api/v1/projects/:id`	`api:projects:write`
`DELETE`	`/api/v1/projects/:id`	`api:projects:write`
`GET`	`/api/v1/directory-records`	`api:participants:read`
`GET`	`/api/v1/participants`	`api:participants:read`
`POST`	`/api/v1/participants`	`api:participants:write`
`GET`	`/api/v1/participants/:id`	`api:participants:read`
`PATCH`	`/api/v1/participants/:id`	`api:participants:write`
`DELETE`	`/api/v1/participants/:id`	`api:participants:write`
`GET`	`/api/v1/participants/:id/members`	`api:participants:read`
`POST`	`/api/v1/participants/:id/members`	`api:participants:write`
`DELETE`	`/api/v1/participants/:id/members/:directory_entry_id`	`api:participants:write`
`GET`	`/api/v1/labels`	`api:labels:read`
`POST`	`/api/v1/labels`	`api:labels:write`
`GET`	`/api/v1/labels/:id`	`api:labels:read`
`PATCH`	`/api/v1/labels/:id`	`api:labels:write`
`DELETE`	`/api/v1/labels/:id`	`api:labels:write`
`GET`	`/api/v1/delegations`	`api:delegations:read`
`POST`	`/api/v1/delegations`	`api:delegations:write`
`GET`	`/api/v1/delegations/:id`	`api:delegations:read`
`PATCH`	`/api/v1/delegations/:id`	`api:delegations:write`
`DELETE`	`/api/v1/delegations/:id`	`api:delegations:write`
`POST`	`/api/v1/resolve`	`api:resolve`
`GET`	`/api/v1/resolve-requests`	`api:resolve-requests:read`
`GET`	`/api/v1/resolve-requests/:id`	`api:resolve-requests:read`
`GET`	`/api/v1/status`	`api:status:read`
`GET`	`/api/v1/observability`	`api:observability:read`
`GET`	`/api/v1/team-members`	`api:team-members:read`
`POST`	`/api/v1/team-members`	`api:team-members:write`
`GET`	`/api/v1/team-members/:id`	`api:team-members:read`
`PATCH`, `DELETE`	`/api/v1/team-members/:id`	`api:team-members:write`
`POST`	`/api/v1/team-members/:id/enable`, `/api/v1/team-members/:id/disable`	`api:team-members:write`
`GET`, `POST`	`/api/v1/ai-agents`	`api:ai-agents:read`, `api:ai-agents:write`
`GET`, `PATCH`, `DELETE`	`/api/v1/ai-agents/:id`	`api:ai-agents:read`, `api:ai-agents:write`
`POST`	`/api/v1/ai-agents/:id/enable`, `/api/v1/ai-agents/:id/disable`	`api:ai-agents:write`
`GET`, `POST`	`/api/v1/service-accounts`	`api:service-accounts:read`, `api:service-accounts:write`
`GET`, `PATCH`, `DELETE`	`/api/v1/service-accounts/:id`	`api:service-accounts:read`, `api:service-accounts:write`
`POST`	`/api/v1/service-accounts/:id/enable`, `/api/v1/service-accounts/:id/disable`	`api:service-accounts:write`
`GET`, `POST`	`/api/v1/api-keys`	`api:api-keys:read`, `api:api-keys:write`
`GET`, `DELETE`	`/api/v1/api-keys/:id`	`api:api-keys:read`, `api:api-keys:write`
`GET`	`/api/v1/audit-events`, `/api/v1/audit-events/:id`	`api:audit-events:read`
`GET`	`/api/v1/model-runs`, `/api/v1/model-runs/:id`	`api:model-runs:read`
`GET`, `POST`	`/api/v1/provider-connectors`	`api:provider-connectors:read`, `api:provider-connectors:write`
`GET`, `PATCH`, `DELETE`	`/api/v1/provider-connectors/:id`	`api:provider-connectors:read`, `api:provider-connectors:write`
`GET`, `PATCH`	`/api/v1/platform-settings`	`api:platform-settings:read`, `api:platform-settings:write`

Use the entity pages in this section for filters, request bodies, response shape notes, and language-specific examples. See Admin Resources for team members, AI agents, service accounts, API keys, audit events, model runs, provider connectors, and platform settings. Error responses use strict Problem Details and intentionally omit legacy error and message fields.

Status Endpoint

GET /api/v1/status returns the active deployment and license status. It is available with api:status:read.

Example response:

{
  "access": {
    "allowed": true,
    "code": "ok",
    "reason": null
  },
  "edition": "pro",
  "release_channel": "production",
  "license": {
    "code": "valid"
  },
  "limits": {
    "effective_human_cap": 100,
    "effective_team_member_cap": null,
    "write_brake_human_cap": 100
  },
  "features": {
    "audit_events": false,
    "model_runs": true,
    "observability": false
  },
  "support_tier": "standard",
  "term_end": "2027-06-16T00:00:00Z",
  "warning": null
}

edition is one of dev_test, free, pro, or enterprise. license.code is one of not_required, missing, valid, grace, or invalid.

Observability Endpoint

GET /api/v1/observability requires api:observability:read, an active admin API-key owner, and Enterprise. It returns database health, worker backlog, active runtime instances, dropped batches, and the sanitized OTLP delivery state.

The response status is disabled, pending, healthy, or degraded. Endpoint values contain origins only—never credentials, headers, or complete paths. delivery_notice explicitly states that exporter health confirms delivery to the OTLP endpoint, not downstream indexing or persistence.

Admin Endpoint Notes

Team members, AI agents, service accounts, API keys, provider connectors, platform settings, and observability are admin-only operational endpoints. Their scopes expose the REST surface, but the API-key owner must still be an active platform admin.

Audit events and model runs are read-only. They also follow edition feature availability from GET /api/v1/status, so unavailable features return a 403 Problem Details response.

Provider connector responses include secret reference names only. They never include secret material. PATCH /api/v1/provider-connectors/:id preserves omitted fields and clears optional fields only when they are sent as null or an empty string.