HTTP API
Generated endpoint, request, response, authentication, and schema reference.
The HTTP API is generated from FastAPI's canonical OpenAPI document. Browser commands use the generated client; this page does not define a second contract.
- Contract title: Lumen API
- Contract version:
0.0.0 - Endpoint count: 124
Authentication schemes
| Name | Type | Scheme | Description |
|---|---|---|---|
HTTPBearer | http | bearer | — |
Endpoints
GET /api/development-project
Development Project
Operation ID: getDevelopmentProject
Authentication: Required: HTTPBearer (http bearer).
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProjectProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/extensions
Curated Extensions
Operation ID: listCuratedExtensions
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
after | query | no | ExtensionId | null | — | ExtensionId: pattern ^ext_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCatalogPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/extensions/{extension_id}
Curated Extension
Operation ID: getCuratedExtension
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
extension_id | path | yes | string | — | pattern ^ext_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCatalogEntry | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/extensions/{extension_id}/tools
Curated Extension Tools
Operation ID: listCuratedExtensionTools
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
extension_id | path | yes | string | — | pattern ^ext_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionToolPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects
Project Page
Operation ID: listProjects
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
after | query | no | ProjectId | null | — | ProjectId: pattern ^prj_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProjectPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects
Create Project Command
Operation ID: createProject
Authentication: Required: HTTPBearer (http bearer).
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateProjectCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}
Project Projection
Operation ID: getProject
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProjectProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/anchors/{anchor_id}
Live Anchor Projection
Operation ID: getLiveAnchor
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
anchor_id | path | yes | string | — | pattern ^anc_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | LiveAnchorProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/anchors/{anchor_id}/selections
Select Live Anchor Command
Operation ID: selectLiveAnchor
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
anchor_id | path | yes | string | — | pattern ^anc_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | SelectLiveAnchorCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/archives/imports
Import Project Archive Command
Operation ID: importProjectArchive
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Command-ID | header | yes | CommandId | — | pattern ^cmd_[0-9a-f]{32}$ | — |
Idempotency-Key | header | yes | string | — | minimum length 8; maximum length 128; pattern ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ | — |
Archive-Digest | header | yes | string | — | pattern ^sha256:[0-9a-f]{64}$ | — |
Archive-Size | header | yes | integer | — | minimum 1; maximum 5368709120 | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/vnd.lumen.project-archive+zip | string |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 202 | application/json | CommandAccepted | CommandRejected | A durable import command, or the identical receipt for an exact replay. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The target project was not found. |
| 413 | application/json | ErrorDetail | The archive is too large. |
| 415 | application/json | ErrorDetail | The media type is unsupported. |
| 422 | application/json | ErrorDetail | Archive verification failed closed. |
| 503 | application/json | ErrorDetail | The trusted worker importer or canonical bytes are unavailable. |
GET /api/projects/{project_id}/archives/latest
Export Project Archive
Operation ID: exportProjectArchive
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/vnd.lumen.project-archive+zip | string | A versioned portable archive with semantic database records, immutable artifact bytes, provenance, and explicit omission disclosures. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The project was not found. |
| 422 | application/json | ErrorDetail | The project cannot be archived. |
| 503 | application/json | ErrorDetail | Canonical artifact bytes are unavailable. |
GET /api/projects/{project_id}/artifacts
Artifact Page
Operation ID: listArtifacts
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | ArtifactId | null | — | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
media_type | query | no | string | null | — | string: minimum length 3; maximum length 255 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ArtifactPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/artifacts/{artifact_id}
Artifact Content
Operation ID: downloadArtifact
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
artifact_id | path | yes | string | — | pattern ^art_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/octet-stream | string | Verified immutable artifact bytes. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Canonical bytes are unavailable. |
GET /api/projects/{project_id}/artifacts/{artifact_id}/manifest
Artifact Manifest
Operation ID: getArtifactManifest
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
artifact_id | path | yes | string | — | pattern ^art_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ArtifactManifest | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/artifacts/{artifact_id}/table/rows
Artifact Table Page
Read a bounded display page without materializing the complete table.
Operation ID: getArtifactTablePage
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
artifact_id | path | yes | string | — | pattern ^art_[0-9a-f]{32}$ | — |
offset | query | no | integer | 0 | minimum 0; maximum 1000000000 | — |
limit | query | no | integer | 100 | minimum 1; maximum 1024 | — |
columns | query | no | array of string | null | — | array of string: minimum items 1; maximum items 512 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TabularArtifactPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 409 | application/json | ErrorDetail | The artifact is not a canonical table. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Artifact verification is unavailable. |
GET /api/projects/{project_id}/artifacts/{artifact_id}/table/schema
Artifact Table Schema
Verify and return the bounded Arrow schema for one canonical Parquet object.
Operation ID: getArtifactTableSchema
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
artifact_id | path | yes | string | — | pattern ^art_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TabularArtifactSchema | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 409 | application/json | ErrorDetail | The artifact is not a canonical table. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Artifact verification is unavailable. |
GET /api/projects/{project_id}/claims
Claim Page
Operation ID: listClaims
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
review_status | query | no | ClaimReviewStatus | null | — | ClaimReviewStatus: values draft, under_review, accepted, rejected, challenged, retracted | — |
validity | query | no | ClaimValidity | null | — | ClaimValidity: values untested, valid-for-pinned-inputs, invalidated, retracted | — |
currentness | query | no | ClaimCurrentness | null | — | ClaimCurrentness: values current, outdated, unknown | — |
after | query | no | ClaimId | null | — | ClaimId: pattern ^clm_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ClaimPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/claims
Create Claim Command
Operation ID: createClaim
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateClaimCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/claims/evidence
Attach Claim Evidence Command
Operation ID: attachClaimEvidence
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AttachEvidenceCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/claims/reviews
Review Claim Command
Operation ID: reviewClaim
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ReviewClaimCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/claims/revisions/{claim_revision_id}/evidence
Claim Evidence Neighborhood
Operation ID: getClaimEvidenceNeighborhood
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
claim_revision_id | path | yes | string | — | pattern ^crv_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 200 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | EvidenceNeighborhood | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/claims/validations
Record Claim Validation Command
Operation ID: recordClaimValidation
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RecordClaimValidationCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/claims/{claim_id}/current
Current Claim Projection
Operation ID: getCurrentClaim
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
claim_id | path | yes | string | — | pattern ^clm_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ClaimRevisionProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/deletion
Project Deletion Projection
Operation ID: getProjectDeletion
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProjectDeletionProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | Deletion was not requested. |
| 422 | application/json | ErrorDetail | The request was invalid. |
POST /api/projects/{project_id}/deletion/export-complete
Acknowledge Project Deletion Export Command
Operation ID: acknowledgeProjectDeletionExport
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AcknowledgeProjectExportCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request was invalid. |
POST /api/projects/{project_id}/deletion/finalize
Finalize Project Deletion Command
Operation ID: finalizeProjectDeletion
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | FinalizeProjectDeletionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request was invalid. |
POST /api/projects/{project_id}/deletion/request
Request Project Deletion Command
Operation ID: requestProjectDeletion
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RequestProjectDeletionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request was invalid. |
GET /api/projects/{project_id}/documents
Document Page
Operation ID: listDocuments
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | DocumentId | null | — | DocumentId: pattern ^doc_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | DocumentPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents
Create Document Command
Operation ID: createDocument
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateDocumentCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/imports/ipynb
Import Ipynb Command
Operation ID: importIpynb
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Command-ID | header | yes | CommandId | — | pattern ^cmd_[0-9a-f]{32}$ | — |
Idempotency-Key | header | yes | string | — | minimum length 8; maximum length 128 | — |
Notebook-Title | header | yes | string | — | minimum length 1; maximum length 240 | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/x-ipynb+json | string |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 413 | application/json | ErrorDetail | The notebook is too large. |
| 415 | application/json | ErrorDetail | The media type is unsupported. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}
Document Projection
Operation ID: getDocument
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | DocumentDetailProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/blocks
Block Page
Operation ID: listBlocks
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
after | query | no | BlockId | null | — | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
before | query | no | BlockId | null | — | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | BlockPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks
Create Block Command
Operation ID: createBlock
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateBlockCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/delete
Delete Block Command
Operation ID: deleteBlock
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | DeleteBlockCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/executions
Execution Page
Operation ID: listBlockExecutions
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
after | query | no | ExecutionId | null | — | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExecutionPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/executions
Execute Block Command
Operation ID: executeBlock
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ExecuteBlockCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/move
Move Block Command
Operation ID: moveBlock
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | MoveBlockCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/patches/accept
Accept Block Patch Command
Operation ID: acceptBlockPatch
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AcceptBlockPatchCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/revisions
Block Revision Page
Operation ID: listBlockRevisions
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
before_revision | query | no | integer | null | — | integer: minimum 1 | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | BlockRevisionPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/revisions
Save Block Revision Command
Operation ID: saveBlockRevision
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | SaveBlockRevisionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/blocks/{block_id}/window
Block Window
Operation ID: getBlockWindow
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
block_id | path | yes | string | — | pattern ^blk_[0-9a-f]{32}$ | — |
before | query | no | integer | 20 | minimum 0; maximum 100 | — |
after | query | no | integer | 20 | minimum 0; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | BlockWindow | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/exports/ipynb
Export Ipynb
Operation ID: exportIpynb
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/x-ipynb+json | string | A deterministic nbformat 4 notebook snapshot. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/documents/{document_id}/search
Block Search Page
Operation ID: searchDocumentBlocks
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
q | query | yes | string | — | minimum length 1; maximum length 200 | — |
after | query | no | BlockId | null | — | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | BlockSearchPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/events
Project Events
Operation ID: streamProjectEvents
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | string | null | — | string: maximum length 64 | — |
follow | query | no | boolean | true | — | — |
Last-Event-ID | header | no | string | null | — | string: maximum length 64 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | text/event-stream | string | SSE frames whose data field is one serialized DomainEvent object. |
| 400 | application/json | ErrorDetail | The event cursor is invalid. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The project was not found. |
| 410 | application/json | ErrorDetail | The event cursor is outside the replay window. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/evidence
Create Evidence Reference Command
Operation ID: createEvidenceReference
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateEvidenceReferenceCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/evidence/retractions
Retract Evidence Command
Operation ID: retractEvidence
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RetractEvidenceCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/evidence/{evidence_ref_id}
Evidence Projection
Operation ID: getEvidence
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
evidence_ref_id | path | yes | string | — | pattern ^evr_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | EvidenceProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Canonical bytes are unavailable. |
GET /api/projects/{project_id}/evidence/{evidence_ref_id}/reference
Evidence Reference Projection
Operation ID: getEvidenceReference
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
evidence_ref_id | path | yes | string | — | pattern ^evr_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | EvidenceReferenceProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/executions/{execution_id}/outputs
Execution Output Page
Operation ID: listExecutionOutputs
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
execution_id | path | yes | string | — | pattern ^exe_[0-9a-f]{32}$ | — |
after | query | no | ExecutionOutputId | null | — | ExecutionOutputId: pattern ^out_[0-9a-f]{32}$ | — |
limit | query | no | integer | 100 | minimum 1; maximum 200 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExecutionOutputPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/experiments
Experiment Page
Operation ID: listExperiments
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | RunId | null | — | RunId: pattern ^run_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExperimentPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical experiment state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/experiments/environments
Experiment Environment Page
Operation ID: listExperimentEnvironments
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | Sha256Digest | null | — | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExperimentEnvironmentPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical experiment state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs
Research Runs
Operation ID: listResearchRuns
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | RunId | null | — | RunId: pattern ^run_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RunPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs
Research Run
Operation ID: createResearchRun
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateResearchRunCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}
Research Run Projection
Operation ID: getResearchRun
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RunDetailProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/approve
Approve Research Plan
Operation ID: approveResearchPlan
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ApprovePlanCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/attempts
Research Run Attempt History
Operation ID: listRunAttemptHistory
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
after | query | no | AttemptId | null | — | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RunAttemptHistoryPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical task history is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/attempts/{attempt_id}
Research Run Attempt History Item
Operation ID: getRunAttemptHistoryItem
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RunAttemptHistoryItem | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical task history is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/attempts/{attempt_id}/local-gateway-bridge-tokens
Issue Local Gateway Bridge Token
Mint or renew one event-only bearer from canonical current state.
Operation ID: issueLocalGatewayBridgeToken
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | LocalGatewayBridgeTokenRequest |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | LocalGatewayBridgeTokenResponse | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The attempt is absent, hidden, terminal, cancelled, or fenced. |
| 422 | application/json | ErrorDetail | The bridge-token request is invalid. |
| 503 | application/json | ErrorDetail | Authentication or bridge-token issuance is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/cancel
Cancel Research Run
Operation ID: cancelResearchRun
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CancelRunCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/graph
Research Task Graph
Pages current-plan nodes by task ID. Each page includes only edges whose predecessor is in that node page, so an edge appears exactly once while its successor may be returned on another page.
Operation ID: getResearchTaskGraph
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
after | query | no | TaskId | null | — | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
limit | query | no | integer | 25 | minimum 1; maximum 25 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TaskGraphPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical task history is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/pause
Pause Research Run
Operation ID: pauseResearchRun
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | PauseRunCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/plan-revisions
Create Research Plan Revision
Operation ID: createResearchPlanRevision
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreatePlanRevisionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | PlanRevisionAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/plan-revisions/approve
Approve Research Plan Revision
Operation ID: approveResearchPlanRevision
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ApprovePlanRevisionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/result
Research Result
Operation ID: getResearchResult
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ResearchResult | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/resume
Resume Research Run
Operation ID: resumeResearchRun
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ResumeRunCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/story
Research Story
Operation ID: getResearchStory
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ResearchStory | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/task-control
Research Task Control Snapshot
Operation ID: getResearchTaskControlSnapshot
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TaskControlSnapshot | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/task-dependencies
Add Research Task Dependency
Operation ID: addResearchTaskDependency
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AddTaskDependencyCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/task-dependencies/remove
Remove Research Task Dependency
Operation ID: removeResearchTaskDependency
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RemoveTaskDependencyCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks
Research Tasks
Operation ID: listResearchTasks
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
after | query | no | TaskId | null | — | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TaskPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks
Create Research Task
Operation ID: createResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/summary
Research Task Summary
Aggregate current-plan tasks and all run attempts without record rows.
Operation ID: getResearchTaskSummary
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TaskSummaryProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical task history is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{source_task_id}/attempts/{source_attempt_id}/messages
Send Research Agent Message
Operation ID: sendResearchAgentMessage
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
source_task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
source_attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | SendAgentMessageCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}
Research Task
Operation ID: getResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | TaskDetailProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/assignment
Assign Research Task
Operation ID: assignResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AssignTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts
Research Attempts
Operation ID: listResearchAttempts
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
after | query | no | integer | null | — | integer: minimum 1 | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | AttemptPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}
Research Attempt
Operation ID: getResearchAttempt
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | AttemptDetailProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/approvals
Tool Approval Page
Operation ID: listToolApprovals
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
after | query | no | InteractionRequestId | null | — | InteractionRequestId: pattern ^int_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ToolApprovalPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/approvals/{approval_id}
Tool Approval Projection
Operation ID: getToolApproval
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
approval_id | path | yes | string | — | pattern ^int_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ToolApproval | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/approvals/{approval_id}/resolve
Resolve Public Tool Approval
Operation ID: resolveToolApproval
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
approval_id | path | yes | string | — | pattern ^int_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ResolveToolApprovalCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/events
Research Attempt Events
Operation ID: listResearchAttemptEvents
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
after | query | no | integer | null | — | integer: minimum 0 | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | AttemptEventPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical attempt history is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/interrupt
Interrupt Research Attempt
Operation ID: interruptResearchAttempt
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | InterruptAttemptCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/attempts/{attempt_id}/steer
Steer Research Attempt
Operation ID: steerResearchAttempt
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | path | yes | string | — | pattern ^att_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | SteerAttemptCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/budget
Update Research Task Budget
Operation ID: updateResearchTaskBudget
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | UpdateTaskBudgetCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/budget-wait/clear
Clear Research Task Budget Wait
Operation ID: clearResearchTaskBudgetWait
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ClearTaskBudgetWaitCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/cancel
Cancel Research Task
Operation ID: cancelResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CancelTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/execution-profile
Update Research Task Execution Profile
Operation ID: updateResearchTaskExecutionProfile
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | UpdateTaskExecutionProfileCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/messages
Research Agent Messages
Operation ID: listResearchAgentMessages
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
attempt_id | query | no | AttemptId | null | — | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
after | query | no | EventId | null | — | EventId: pattern ^eve_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | AgentMessagePage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/pause
Pause Research Task
Operation ID: pauseResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | PauseTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/resume
Resume Research Task
Operation ID: resumeResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ResumeTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/retry
Retry Research Task
Operation ID: retryResearchTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RetryTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
POST /api/projects/{project_id}/runs/{run_id}/tasks/{task_id}/update
Update Research Draft Task
Operation ID: updateResearchDraftTask
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | path | yes | string | — | pattern ^run_[0-9a-f]{32}$ | — |
task_id | path | yes | string | — | pattern ^tsk_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | UpdateDraftTaskCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is unavailable. |
GET /api/projects/{project_id}/schedules
Research Schedules
Operation ID: listResearchSchedules
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | ScheduleId | null | — | ScheduleId: pattern ^sch_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | SchedulePage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical schedule state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/schedules
Create Research Schedule
Operation ID: createResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateScheduleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/schedules/{schedule_id}
Research Schedule
Operation ID: getResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | path | yes | string | — | pattern ^sch_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ScheduleDetailProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical schedule state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
PUT /api/projects/{project_id}/schedules/{schedule_id}
Update Research Schedule
Operation ID: updateResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | path | yes | string | — | pattern ^sch_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | UpdateScheduleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/schedules/{schedule_id}/delete
Delete Research Schedule
Operation ID: deleteResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | path | yes | string | — | pattern ^sch_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | DeleteScheduleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/schedules/{schedule_id}/pause
Pause Research Schedule
Operation ID: pauseResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | path | yes | string | — | pattern ^sch_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | PauseScheduleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/schedules/{schedule_id}/resume
Resume Research Schedule
Operation ID: resumeResearchSchedule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | path | yes | string | — | pattern ^sch_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ResumeScheduleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/search
Project Search
Operation ID: searchProject
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
q | query | yes | string | — | minimum length 1; maximum length 200 | — |
kinds | query | no | array of ProductSearchKind | null | — | — | — |
limit | query | no | integer | 30 | minimum 1; maximum 50 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProductSearchPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The project was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
PUT /api/projects/{project_id}/settings
Project Settings
Operation ID: updateProjectSettings
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | UpdateProjectSettingsCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/variables
Variable Page
Operation ID: listVariables
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | VariablePage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/variables/definitions
Set Variable Definition Command
Operation ID: setVariableDefinition
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | SetVariableDefinitionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/variables/retractions
Retract Variable Value Command
Operation ID: retractVariableValue
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RetractVariableValueCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/projects/{project_id}/variables/values
Capture Variable Value Command
Operation ID: captureVariableValue
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CaptureVariableValueCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/projects/{project_id}/workspace
Project Workspace Projection
Operation ID: getProjectWorkspace
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | WorkspaceSnapshotProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The exact project artifact was not found. |
| 422 | application/json | ErrorDetail | The immutable workspace artifact failed contract verification. |
| 503 | application/json | ErrorDetail | Canonical database or artifact storage is unavailable. |
POST /api/projects/{project_id}/workspace/change-sets/acceptances
Accept Project Workspace Change Set Command
Operation ID: acceptProjectWorkspaceChangeSet
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | AcceptWorkspaceChangeSetCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The exact project artifact was not found. |
| 422 | application/json | ErrorDetail | The immutable workspace artifact failed contract verification. |
| 503 | application/json | ErrorDetail | Canonical database or artifact storage is unavailable. |
POST /api/projects/{project_id}/workspace/change-sets/rejections
Reject Project Workspace Change Set Command
Operation ID: rejectProjectWorkspaceChangeSet
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | RejectWorkspaceChangeSetCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | CommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The exact project artifact was not found. |
| 422 | application/json | ErrorDetail | The immutable workspace artifact failed contract verification. |
| 503 | application/json | ErrorDetail | Canonical database or artifact storage is unavailable. |
GET /api/projects/{project_id}/workspace/change-sets/{change_set_artifact_id}
Project Workspace Change Set Projection
Operation ID: getProjectWorkspaceChangeSet
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
change_set_artifact_id | path | yes | string | — | pattern ^art_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ProjectWorkspaceChangeSetProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The exact project artifact was not found. |
| 422 | application/json | ErrorDetail | The immutable workspace artifact failed contract verification. |
| 503 | application/json | ErrorDetail | Canonical database or artifact storage is unavailable. |
GET /api/projects/{project_id}/writeups/{document_id}/exports/{export_format}
Export Writeup
Operation ID: exportWriteup
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
project_id | path | yes | string | — | pattern ^prj_[0-9a-f]{32}$ | — |
document_id | path | yes | string | — | pattern ^doc_[0-9a-f]{32}$ | — |
export_format | path | yes | markdown | html | pdf | latex | — | values markdown, html, pdf, latex | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/pdf | string | A deterministic export of exact current writeup block revisions with pinned claim/evidence/artifact state and explicit omission disclosures. |
| 200 | application/vnd.lumen.writeup.latex+zip | string | A deterministic export of exact current writeup block revisions with pinned claim/evidence/artifact state and explicit omission disclosures. |
| 200 | application/vnd.lumen.writeup.markdown+zip | string | A deterministic export of exact current writeup block revisions with pinned claim/evidence/artifact state and explicit omission disclosures. |
| 200 | text/html | string | A deterministic export of exact current writeup block revisions with pinned claim/evidence/artifact state and explicit omission disclosures. |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The writeup was not found. |
| 413 | application/json | ErrorDetail | The bounded export is too large. |
| 422 | application/json | ErrorDetail | The writeup cannot be rendered safely. |
| 503 | application/json | ErrorDetail | Canonical artifact bytes are unavailable. |
GET /api/retention-policies
Retention Policy Catalog
Operation ID: listDataRetentionPolicies
Authentication: Required: HTTPBearer (http bearer).
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | DataRetentionPolicyCatalog | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
POST /api/runtime-tickets
Issue Browser Runtime Ticket
Operation ID: issueRuntimeTicket
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
Origin | header | no | string | null | — | — | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ExecutionTicketRequest | PtyTicketRequest | RuntimeControlTicketRequest |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RuntimeTicketGrant | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 403 | application/json | ErrorDetail | The browser origin is not allowed. |
| 409 | application/json | ErrorDetail | Canonical runtime state is unavailable. |
| 422 | application/json | ErrorDetail | The runtime ticket request is invalid. |
| 503 | application/json | ErrorDetail | Runtime ticket issuance is unavailable. |
GET /api/settings/catalog
Get Settings Catalog
Operation ID: getSettingsCatalog
Authentication: Required: HTTPBearer (http bearer).
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | SettingsCatalog | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/workspaces/{workspace_id}/extension-capability-diffs/{extension_id}/{version_digest}
Workspace Extension Capability Diff
Operation ID: getWorkspaceExtensionCapabilityDiff
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
extension_id | path | yes | string | — | pattern ^ext_[0-9a-f]{32}$ | — |
version_digest | path | yes | string | — | pattern ^sha256:[0-9a-f]{64}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCapabilityDiffPreview | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 409 | application/json | ErrorDetail | The selected extension version is not usable. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/workspaces/{workspace_id}/extensions
Workspace Extension Installations
Operation ID: listWorkspaceExtensionInstallations
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
after | query | no | ExtensionInstallationId | null | — | ExtensionInstallationId: pattern ^ins_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionInstallationPage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/workspaces/{workspace_id}/extensions
Install Workspace Extension
Operation ID: installWorkspaceExtension
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | InstallExtensionCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/workspaces/{workspace_id}/extensions/{installation_id}
Workspace Extension Installation
Operation ID: getWorkspaceExtensionInstallation
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
installation_id | path | yes | string | — | pattern ^ins_[0-9a-f]{32}$ | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionInstallationProjection | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The resource was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/workspaces/{workspace_id}/extensions/{installation_id}/tools/{tool_id}/disable
Disable Workspace Extension Tool
Operation ID: disableWorkspaceExtensionTool
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
installation_id | path | yes | string | — | pattern ^ins_[0-9a-f]{32}$ | — |
tool_id | path | yes | string | — | — | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | DisableExtensionToolCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/workspaces/{workspace_id}/extensions/{installation_id}/tools/{tool_id}/enable
Enable Workspace Extension Tool
Operation ID: enableWorkspaceExtensionTool
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
installation_id | path | yes | string | — | pattern ^ins_[0-9a-f]{32}$ | — |
tool_id | path | yes | string | — | — | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | EnableExtensionToolCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ExtensionCommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical extension state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /api/workspaces/{workspace_id}/rules
Scoped Rules
Operation ID: listScopedRules
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
project_id | query | no | ProjectId | null | — | ProjectId: pattern ^prj_[0-9a-f]{32}$ | — |
after | query | no | RuleId | null | — | RuleId: pattern ^rul_[0-9a-f]{32}$ | — |
limit | query | no | integer | 50 | minimum 1; maximum 100 | — |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | ScopedRulePage | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The workspace or project was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical rule state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
POST /api/workspaces/{workspace_id}/rules
Create Rule
Operation ID: createScopedRule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | CreateScopedRuleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RuleCommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The workspace or project was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical rule state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
PUT /api/workspaces/{workspace_id}/rules/{rule_id}
Replace Rule
Operation ID: replaceScopedRule
Authentication: Required: HTTPBearer (http bearer).
Parameters
| Name | Location | Required | Type | Default | Constraints | Description |
|---|---|---|---|---|---|---|
workspace_id | path | yes | string | — | pattern ^wsp_[0-9a-f]{32}$ | — |
rule_id | path | yes | string | — | pattern ^rul_[0-9a-f]{32}$ | — |
Request body
Required: yes
| Media type | Contract |
|---|---|
application/json | ReplaceScopedRuleCommand |
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | RuleCommandAccepted | CommandRejected | Successful Response |
| 401 | application/json | ErrorDetail | Authentication failed. |
| 404 | application/json | ErrorDetail | The workspace or project was not found. |
| 422 | application/json | ErrorDetail | The request is invalid. |
| 500 | application/json | ErrorDetail | Canonical rule state is invalid. |
| 503 | application/json | ErrorDetail | Authentication is temporarily unavailable. |
GET /health/live
Live Health
Operation ID: getLiveHealth
Authentication: No bearer credential is declared for this endpoint.
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | HealthReport | Successful Response |
GET /health/ready
Ready Health
Operation ID: getReadyHealth
Authentication: No bearer credential is declared for this endpoint.
Responses
| Status | Media type | Contract | Description |
|---|---|---|---|
| 200 | application/json | HealthReport | Successful Response |
| 503 | application/json | HealthReport | App dependencies are unavailable. |
Schemas
AcceptBlockPatchCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AcceptBlockPatchPayload | unknown fields forbidden | — |
AcceptBlockPatchPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_current_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
expected_structure_version | yes | integer | minimum 1.0 | — |
language | no | BlockLanguage | null | BlockLanguage: minimum length 1; maximum length 64 | — |
metadata | no | object | — | — |
proposed_base_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
resolved_source | yes | BlockSource | maximum length 1048576 | — |
source_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
AcceptWorkspaceChangeSetCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AcceptWorkspaceChangeSetPayload | unknown fields forbidden | — |
AcceptWorkspaceChangeSetPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
candidate_snapshot_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
candidate_snapshot_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
change_set_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
change_set_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
expected_workspace_version | yes | integer | minimum 0.0 | — |
AcceptanceCriterion
Type: string Constraints: minimum length 1; maximum length 500
AcceptedMetricClaim
One exact accepted current metric revision produced by this run.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_id | yes | ClaimId | pattern ^clm_[0-9a-f]{32}$ | — |
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
confidence_assessment | yes | string | null | string: minimum length 1; maximum length 2000 | — |
content_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
currentness | yes | ClaimCurrentness | values current, outdated, unknown | — |
priority | yes | integer | minimum -1000.0; maximum 1000.0 | — |
producing_attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
producing_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
text | yes | MetricText | minimum length 1; maximum length 65536 | — |
title | yes | MetricTitle | minimum length 1; maximum length 240 | — |
validity | yes | ClaimValidity | values untested, valid-for-pinned-inputs, invalidated, retracted | — |
AcknowledgeProjectExportCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AcknowledgeProjectExportPayload | unknown fields forbidden | — |
AcknowledgeProjectExportPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
archive_manifest_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
deletion_generation | yes | integer | minimum 1.0 | — |
expected_deletion_version | yes | integer | minimum 1.0 | — |
expected_project_version | yes | integer | minimum 1.0 | — |
AddTaskDependencyCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AddTaskDependencyPayload | unknown fields forbidden | — |
AddTaskDependencyPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
predecessor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
reason | yes | DependencyReason | minimum length 1; maximum length 1000 | — |
successor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
AgentEventUnion
Discriminator: event_type
Type: AttemptLifecycleEvent | MessageEvent | ReasoningSummaryEvent | ToolEvent | ApprovalEvent | ArtifactPublishedEvent | ClaimProposedEvent | TaskProposedEvent | UsageUpdatedEvent | CheckpointCreatedEvent Constraints: AttemptLifecycleEvent: unknown fields forbidden; MessageEvent: unknown fields forbidden; ReasoningSummaryEvent: unknown fields forbidden; ToolEvent: unknown fields forbidden; ApprovalEvent: unknown fields forbidden; ArtifactPublishedEvent: unknown fields forbidden; ClaimProposedEvent: unknown fields forbidden; TaskProposedEvent: unknown fields forbidden; UsageUpdatedEvent: unknown fields forbidden; CheckpointCreatedEvent: unknown fields forbidden
AgentMessageContent
Type: string Constraints: minimum length 1; maximum length 16384
AgentMessagePage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of AgentMessageProjection | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | EventId | null | EventId: pattern ^eve_[0-9a-f]{32}$ | — |
AgentMessageProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
content | yes | string | minimum length 1; maximum length 16384 | — |
created_at | yes | string | format date-time | — |
message_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
source_attempt_generation | yes | integer | minimum 1.0 | — |
source_attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
source_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
target_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
target_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
AgentSkillVersion
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
compatibility | no | string | null | string: minimum length 1; maximum length 500 | — |
description | yes | string | minimum length 1; maximum length 1024 | — |
instructions_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
instructions_size_bytes | yes | integer | minimum 1.0; maximum 262144.0 | — |
license | yes | string | minimum length 1; maximum length 128 | — |
metadata | no | object | maximum properties 64 | — |
name | yes | SkillName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$ | — |
resources | no | array of SkillResourceSummary | maximum items 128; default [] | — |
trust_label | no | untrusted_instruction | fixed value untrusted_instruction; default "untrusted_instruction" | — |
ApprovalAction
Type: string Constraints: minimum length 1; maximum length 240
ApprovalActorLabel
Type: string Constraints: minimum length 1; maximum length 120
ApprovalEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approval_id | yes | string | — | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
decision | yes | pending | approved | denied | expired | cancelled | values pending, approved, denied, expired, cancelled | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | approval.requested | approval.resolved | values approval.requested, approval.resolved | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
ApprovalResolution
A terminal decision, including product-owned timeout and cancellation.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
decision | yes | allow | deny | expired | cancelled | values allow, deny, expired, cancelled | — |
reason | no | string | null | string: minimum length 1; maximum length 500 | — |
ApprovalSummary
Type: string Constraints: minimum length 1; maximum length 500
ApprovalTarget
Type: string Constraints: minimum length 1; maximum length 500
ApprovePlanCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ApprovePlanPayload | unknown fields forbidden | — |
ApprovePlanPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
ApprovePlanRevisionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ApprovePlanRevisionPayload | unknown fields forbidden | — |
ApprovePlanRevisionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
revision | yes | integer | minimum 1.0 | — |
ArtifactEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
target_kind | yes | artifact | fixed value artifact | — |
ArtifactId
Type: string
Constraints: pattern ^art_[0-9a-f]{32}$
ArtifactManifest
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
created_at | yes | string | format date-time | — |
digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
media_type | yes | string | minimum length 1; maximum length 255 | — |
producing_attempt_id | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
producing_execution_id | no | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
producing_import_id | no | ProjectImportId | null | ProjectImportId: pattern ^imp_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
size_bytes | yes | integer | minimum 0.0 | — |
storage_key | yes | string | minimum length 1; maximum length 1024 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ArtifactPage
One deterministic project-scoped page without artifact bytes.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ArtifactManifest | maximum items 100 | — |
next_after | no | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
ArtifactPublishedEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | artifact.published | fixed value artifact.published | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
ArtifactSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
kind | yes | artifact | fixed value artifact | — |
producing_attempt_id | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
producing_execution_id | no | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
AssignTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AssignTaskPayload | unknown fields forbidden | — |
AssignTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
assignment_policy | yes | TaskAssignmentPolicy | values automatic, operator | — |
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
AttachEvidenceCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | AttachEvidencePayload | unknown fields forbidden | — |
AttachEvidencePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attachment | yes | EvidenceAttachment | unknown fields forbidden | — |
dependent_id | yes | ClaimRevisionId | VariableValueId | ClaimRevisionId: pattern ^crv_[0-9a-f]{32}$; VariableValueId: pattern ^val_[0-9a-f]{32}$ | — |
dependent_kind | yes | EvidenceDependentKind | values claim_revision, variable_value | — |
expected_claim_version | no | integer | null | integer: minimum 1.0 | — |
AttemptDetailProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt | yes | AttemptProjection | unknown fields forbidden | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
AttemptEventPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of AttemptEventProjection | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | integer | null | integer: minimum 0.0 | — |
AttemptEventProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
applies_to_current_generation | yes | boolean | — | — |
attempt_generation | yes | integer | minimum 1.0 | — |
event | yes | AgentEventUnion | AttemptLifecycleEvent: unknown fields forbidden; MessageEvent: unknown fields forbidden; ReasoningSummaryEvent: unknown fields forbidden; ToolEvent: unknown fields forbidden; ApprovalEvent: unknown fields forbidden; ArtifactPublishedEvent: unknown fields forbidden; ClaimProposedEvent: unknown fields forbidden; TaskProposedEvent: unknown fields forbidden; UsageUpdatedEvent: unknown fields forbidden; CheckpointCreatedEvent: unknown fields forbidden | — |
AttemptEventSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
kind | yes | attempt_event | fixed value attempt_event | — |
provider_sequence | yes | integer | minimum 0.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
AttemptId
Type: string
Constraints: pattern ^att_[0-9a-f]{32}$
AttemptLifecycleEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
detail | no | string | null | — | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | attempt.queued | attempt.provisioning | attempt.started | attempt.paused | attempt.resumed | attempt.completed | attempt.failed | attempt.cancelled | values attempt.queued, attempt.provisioning, attempt.started, attempt.paused, attempt.resumed, attempt.completed, attempt.failed, attempt.cancelled | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
AttemptPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of AttemptProjection | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | integer | null | integer: minimum 1.0 | — |
AttemptProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_generation | yes | integer | minimum 1.0 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
attempt_number | yes | integer | minimum 1.0 | — |
capability_policy_version | yes | integer | minimum 1.0 | — |
capability_revocation_version | yes | integer | minimum 1.0 | — |
created_at | yes | string | format date-time | — |
current_generation | yes | integer | minimum 1.0 | — |
current_plan_revision | yes | integer | minimum 1.0 | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
finished_at | yes | string | null | string: format date-time | — |
is_current_generation | yes | boolean | — | — |
is_latest_attempt | yes | boolean | — | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
plan_revision | yes | integer | minimum 1.0 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
started_at | yes | string | null | string: format date-time | — |
summary | yes | string | null | — | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
version | yes | integer | minimum 1.0 | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
AttemptStateGroup
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
count | yes | integer | minimum 1.0 | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
is_current_generation | yes | boolean | — | — |
is_current_plan_revision | yes | boolean | — | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
BlockId
Type: string
Constraints: pattern ^blk_[0-9a-f]{32}$
BlockLanguage
Type: string Constraints: minimum length 1; maximum length 64
BlockPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of BlockProjection | — | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
next_before | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
structure_version | yes | integer | minimum 1.0 | — |
BlockProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
block_type | yes | BlockType | values code, markdown, raw, artifact, query | — |
created_at | yes | string | format date-time | — |
current_revision | yes | BlockRevisionProjection | unknown fields forbidden | — |
deleted | yes | boolean | — | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
rank | yes | integer | minimum 1.0; maximum 9007199254740991.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
BlockRevisionEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
target_kind | yes | block_revision | fixed value block_revision | — |
BlockRevisionId
Type: string
Constraints: pattern ^rev_[0-9a-f]{32}$
BlockRevisionPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of BlockRevisionProjection | — | — |
next_before_revision | no | integer | null | integer: minimum 1.0 | — |
BlockRevisionProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
author_id | yes | string | — | — |
author_type | yes | human | attempt | system | import | values human, attempt, system, import | — |
base_revision_id | yes | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
content_hash | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
language | yes | string | null | — | — |
merge_parent_revision_id | yes | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
metadata | yes | object | — | — |
revision | yes | integer | minimum 1.0 | — |
source | yes | string | — | — |
source_artifact_id | yes | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
BlockSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
kind | yes | block | fixed value block | — |
BlockSearchPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of BlockSearchResult | — | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
structure_version | yes | integer | minimum 1.0 | — |
BlockSearchResult
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
block_type | yes | BlockType | values code, markdown, raw, artifact, query | — |
rank | yes | integer | minimum 1.0 | — |
source_excerpt | yes | string | — | — |
BlockSource
Type: string Constraints: maximum length 1048576
BlockType
Type: code | markdown | raw | artifact | query
Constraints: values code, markdown, raw, artifact, query
BlockWindow
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
anchor_block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
anchor_present | yes | boolean | — | — |
items | yes | array of BlockProjection | — | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
structure_version | yes | integer | minimum 1.0 | — |
BudgetScope
Type: workspace | project | run | task | attempt
Constraints: values workspace, project, run, task, attempt
CancelRunCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CancelRunPayload | unknown fields forbidden | — |
CancelRunPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
reason | yes | CancellationReason | minimum length 1; maximum length 1000 | — |
CancelTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CancelTaskPayload | unknown fields forbidden | — |
CancelTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
reason | yes | CancellationReason | minimum length 1; maximum length 1000 | — |
CancellationReason
Type: string Constraints: minimum length 1; maximum length 1000
CaptureVariableValueCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CaptureVariableValuePayload | unknown fields forbidden | — |
CaptureVariableValuePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | no | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
block_revision_id | no | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
dependencies | no | array of EvidenceAttachment | maximum items 256; default [] | — |
environment_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
expected_definition_version | yes | integer | minimum 1.0 | — |
inline | no | InlineVariableValue | null | InlineVariableValue: unknown fields forbidden | — |
input_manifest | no | object | — | — |
origin | yes | VariableValueOrigin | values captured, manual, imported | — |
producing_execution_id | no | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
select_as_live | no | boolean | default false | — |
source_import_id | no | ProjectImportId | null | ProjectImportId: pattern ^imp_[0-9a-f]{32}$ | — |
value_manifest | yes | object | — | — |
variable_definition_id | yes | VariableDefinitionId | pattern ^vdf_[0-9a-f]{32}$ | — |
CheckpointCreatedEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
checkpoint_id | yes | string | — | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | checkpoint.created | fixed value checkpoint.created | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
ClaimCurrentness
Type: current | outdated | unknown
Constraints: values current, outdated, unknown
ClaimId
Type: string
Constraints: pattern ^clm_[0-9a-f]{32}$
ClaimPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ClaimRevisionProjection | — | — |
next_after | no | ClaimId | null | ClaimId: pattern ^clm_[0-9a-f]{32}$ | — |
ClaimProposedEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
claim_id | yes | ClaimId | pattern ^clm_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | claim.proposed | fixed value claim.proposed | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
ClaimReviewStatus
Type: draft | under_review | accepted | rejected | challenged | retracted
Constraints: values draft, under_review, accepted, rejected, challenged, retracted
ClaimRevisionEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
target_kind | yes | claim_revision | fixed value claim_revision | — |
ClaimRevisionId
Type: string
Constraints: pattern ^crv_[0-9a-f]{32}$
ClaimRevisionProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
aggregate_version | yes | integer | minimum 1.0 | — |
author | yes | KnowledgeActor | unknown fields forbidden | — |
claim_id | yes | ClaimId | pattern ^clm_[0-9a-f]{32}$ | — |
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
claim_type | yes | ClaimType | values text, metric, table, figure, imported | — |
confidence_assessment | yes | string | null | — | — |
content_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
currentness | yes | ClaimCurrentness | values current, outdated, unknown | — |
priority | yes | integer | minimum -1000.0; maximum 1000.0 | — |
producing_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
producing_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
review_reason | yes | string | null | — | — |
review_status | yes | ClaimReviewStatus | values draft, under_review, accepted, rejected, challenged, retracted | — |
reviewed_at | yes | string | null | string: format date-time | — |
reviewed_by | yes | string | null | — | — |
revision | yes | integer | minimum 1.0 | — |
text | yes | string | — | — |
title | yes | string | — | — |
validity | yes | ClaimValidity | values untested, valid-for-pinned-inputs, invalidated, retracted | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ClaimSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_id | yes | ClaimId | pattern ^clm_[0-9a-f]{32}$ | — |
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
kind | yes | claim | fixed value claim | — |
ClaimType
Type: text | metric | table | figure | imported
Constraints: values text, metric, table, figure, imported
ClaimValidationId
Type: string
Constraints: pattern ^vld_[0-9a-f]{32}$
ClaimValidationProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
claim_validation_id | yes | ClaimValidationId | pattern ^vld_[0-9a-f]{32}$ | — |
content_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
input_manifest | yes | object | — | — |
method | yes | ValidationMethod | values rerun, fresh_sandbox_replication, independent_implementation, leakage_check, perturbation, statistical_check, data_quality_check, contradiction_search, raw_metric_check | — |
outcome | yes | ValidationOutcome | values passed, failed, inconclusive, error | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
result_evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
summary | yes | string | — | — |
verifying_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
verifying_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ClaimValidity
Type: untested | valid-for-pinned-inputs | invalidated | retracted
Constraints: values untested, valid-for-pinned-inputs, invalidated, retracted
ClearTaskBudgetWaitCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ClearTaskBudgetWaitPayload | unknown fields forbidden | — |
ClearTaskBudgetWaitPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
CommandAccepted
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
aggregate_id | yes | string | — | — |
aggregate_version | yes | integer | minimum 1.0 | — |
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
first_event_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
status | no | accepted | fixed value accepted; default "accepted" | — |
CommandId
Type: string
Constraints: pattern ^cmd_[0-9a-f]{32}$
CommandRejected
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
code | yes | string | pattern ^[a-z][a-z0-9_.-]+$ | — |
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
message | yes | string | minimum length 1; maximum length 500 | — |
observed_revision_id | no | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
observed_structure_version | no | integer | null | integer: minimum 1.0 | — |
observed_version | no | integer | null | integer: minimum 1.0 | — |
retry_after_ms | no | integer | null | integer: minimum 0.0 | — |
retryable | no | boolean | default false | — |
status | no | rejected | fixed value rejected; default "rejected" | — |
ConnectorActivation
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
allowed_target_count | yes | integer | minimum 0.0; maximum 100.0 | — |
connector_id | no | github | fixed value github; default "github" | — |
mutating_actions_require_approval | no | True | fixed value True; default true | — |
status | yes | configured | unconfigured | values configured, unconfigured | — |
CreateBlockCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateBlockPayload | unknown fields forbidden | — |
CreateBlockPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
after_block_id | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
before_block_id | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
block_type | yes | BlockType | values code, markdown, raw, artifact, query | — |
expected_structure_version | yes | integer | minimum 1.0 | — |
language | no | BlockLanguage | null | BlockLanguage: minimum length 1; maximum length 64 | — |
metadata | no | object | — | — |
source | yes | BlockSource | maximum length 1048576 | — |
CreateClaimCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateClaimPayload | unknown fields forbidden | — |
CreateClaimPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_type | yes | ClaimType | values text, metric, table, figure, imported | — |
confidence_assessment | no | string | null | string: minimum length 1; maximum length 2000 | — |
evidence | no | array of EvidenceAttachment | maximum items 256; default [] | — |
priority | no | integer | minimum -1000.0; maximum 1000.0; default 0 | — |
text | yes | string | minimum length 1; maximum length 65536 | — |
title | yes | string | minimum length 1; maximum length 240 | — |
CreateDocumentCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateDocumentPayload | unknown fields forbidden | — |
CreateDocumentPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
kind | yes | DocumentKind | values notebook, writeup | — |
metadata | no | object | — | — |
title | yes | DocumentTitle | minimum length 1; maximum length 240 | — |
CreateEvidenceReferenceCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateEvidenceReferencePayload | unknown fields forbidden | — |
CreateEvidenceReferencePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
locator | no | object | — | — |
target | yes | EvidenceTarget | ArtifactEvidenceTarget: unknown fields forbidden; BlockRevisionEvidenceTarget: unknown fields forbidden; ExecutionOutputEvidenceTarget: unknown fields forbidden; VariableValueEvidenceTarget: unknown fields forbidden; ClaimRevisionEvidenceTarget: unknown fields forbidden; HumanAssertionEvidenceTarget: unknown fields forbidden | — |
CreatePlanRevisionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreatePlanRevisionPayload | unknown fields forbidden | — |
CreatePlanRevisionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
spec | yes | PlanRevisionSpec | unknown fields forbidden | — |
CreateProjectCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateProjectPayload | unknown fields forbidden | — |
CreateProjectPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
name | yes | ProjectName | minimum length 1; maximum length 200 | — |
workspace_id | no | WorkspaceId | null | WorkspaceId: pattern ^wsp_[0-9a-f]{32}$ | — |
workspace_name | no | WorkspaceName | null | WorkspaceName: minimum length 1; maximum length 200 | — |
CreateResearchRunCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateResearchRunPayload | unknown fields forbidden | — |
CreateResearchRunPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
max_cost_micros | no | integer | minimum 0.0; maximum 10000000000.0; default 15512000 | — |
objective | yes | ResearchObjective | minimum length 12; maximum length 4000 | — |
references | no | array of ResearchReference | maximum items 32; default [] | — |
start_immediately | no | boolean | default true | — |
CreateScheduleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateSchedulePayload | unknown fields forbidden | — |
CreateSchedulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
start_paused | no | boolean | default false | — |
template | yes | ScheduleRunTemplate | unknown fields forbidden | — |
timing | yes | ScheduleTiming | unknown fields forbidden | — |
CreateScopedRuleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateScopedRulePayload | unknown fields forbidden | — |
CreateScopedRulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
enabled | no | boolean | default true | — |
instructions | yes | RuleInstructions | minimum length 1; maximum length 8192 | — |
project_id | no | ProjectId | null | ProjectId: pattern ^prj_[0-9a-f]{32}$ | — |
scope_kind | yes | RuleScopeKind | values workspace, project | — |
title | yes | RuleTitle | minimum length 1; maximum length 200 | — |
CreateTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | CreateTaskPayload | unknown fields forbidden | — |
CreateTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
acceptance_criteria | yes | array of AcceptanceCriterion | minimum items 1; maximum items 20 | — |
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
objective | yes | TaskObjective | minimum length 1; maximum length 4000 | — |
title | yes | TaskTitle | minimum length 1; maximum length 240 | — |
Cursor
Type: string
Constraints: pattern ^c2_[A-Za-z0-9_-]{32}$
DataClassification
Type: public | internal | confidential | restricted
Constraints: values public, internal, confidential, restricted
DataRetentionPolicy
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
backup_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
data_class | yes | RetentionDataClass | values transient_stream_chunks, ordinary_project_state, immutable_evidence_artifacts, sensitive_source_data, provider_prompts_responses, audit_security_events, deleted_export_pending | — |
deletion_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
description | yes | string | minimum length 1; maximum length 1000 | — |
encryption_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
export_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
model_provider_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
policy_version | no | 1 | fixed value 1; default 1 | — |
region_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
retention_handling | yes | RetentionCode | pattern ^[a-z][a-z0-9_.-]{1,127}$ | — |
DataRetentionPolicyCatalog
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of DataRetentionPolicy | minimum items 7; maximum items 7 | — |
policy_version | no | 1 | fixed value 1; default 1 | — |
DeleteBlockCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | DeleteBlockPayload | unknown fields forbidden | — |
DeleteBlockPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
expected_structure_version | yes | integer | minimum 1.0 | — |
DeleteScheduleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | DeleteSchedulePayload | unknown fields forbidden | — |
DeleteSchedulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_version | yes | integer | minimum 1.0 | — |
reason | yes | ScheduleDeletionReason | minimum length 1; maximum length 1000 | — |
DependencyHandoff
The explicit data contract carried by one dependency edge.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
required_outputs | no | array of HandoffRequirement | maximum items 32; default [] | — |
DependencyReason
Type: string Constraints: minimum length 1; maximum length 1000
DesiredState
Type: running | paused | cancelled
Constraints: values running, paused, cancelled
DisableExtensionToolCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | DisableExtensionToolPayload | unknown fields forbidden | — |
DisableExtensionToolPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_installation_version | yes | integer | minimum 1.0 | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
DocumentDetailProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
document | yes | DocumentProjection | unknown fields forbidden | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
DocumentId
Type: string
Constraints: pattern ^doc_[0-9a-f]{32}$
DocumentKind
Type: notebook | writeup
Constraints: values notebook, writeup
DocumentPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of DocumentProjection | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | DocumentId | null | DocumentId: pattern ^doc_[0-9a-f]{32}$ | — |
DocumentProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
created_at | yes | string | format date-time | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
kind | yes | DocumentKind | values notebook, writeup | — |
metadata | yes | object | — | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
structure_version | yes | integer | minimum 1.0 | — |
title | yes | string | — | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
DocumentTitle
Type: string Constraints: minimum length 1; maximum length 240
DomainEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
actor | yes | EventActor | unknown fields forbidden | — |
aggregate_id | yes | string | — | — |
aggregate_type | yes | string | — | — |
aggregate_version | yes | integer | minimum 1.0 | — |
causation_id | yes | string | — | — |
correlation_id | yes | string | — | — |
cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | string | pattern ^[a-z][a-z0-9_.-]+$ | — |
occurred_at | yes | string | format date-time | — |
payload | yes | object | — | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
schema_version | no | 1 | fixed value 1; default 1 | — |
trace_id | yes | string | — | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
EnableExtensionToolCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | EnableExtensionToolPayload | unknown fields forbidden | — |
EnableExtensionToolPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approve_external_side_effects | yes | True | fixed value True | — |
expected_installation_version | yes | integer | minimum 1.0 | — |
presented_capability_diff_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
secret_bindings | no | array of ExtensionSecretBindingInput | maximum items 32; default [] | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
EnvironmentCapability
Type: string
Constraints: pattern ^[a-z][a-z0-9_.-]{0,63}$
EnvironmentManifestContent
The bounded, non-secret facts needed to identify one execution environment.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
build_id | yes | string | minimum length 1; maximum length 128 | — |
egress_policy | yes | fixture | block_all | values fixture, block_all | — |
image_reference | yes | string | null | string: minimum length 1; maximum length 512 | — |
kernel | yes | fake | ipykernel | values fake, ipykernel | — |
node_version | yes | RuntimeVersion | null | RuntimeVersion: maximum length 64; pattern ^[0-9]+(?:\.[0-9]+){1,3}(?:[a-z0-9.+-]*)?$ | — |
pi_agent_core_version | yes | RuntimeVersion | null | RuntimeVersion: maximum length 64; pattern ^[0-9]+(?:\.[0-9]+){1,3}(?:[a-z0-9.+-]*)?$ | — |
platform | yes | linux/amd64 | linux/arm64 | null | linux/amd64 | linux/arm64: values linux/amd64, linux/arm64 | — |
provider | yes | fixture | local_docker | daytona | values fixture, local_docker, daytona | — |
python_version | yes | RuntimeVersion | maximum length 64; pattern ^[0-9]+(?:\.[0-9]+){1,3}(?:[a-z0-9.+-]*)?$ | — |
resolved_image_id | yes | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
runtime_kind | yes | fixture | container | values fixture, container | — |
schema_version | no | 1 | fixed value 1; default 1 | — |
security_profile | yes | string | pattern ^[a-z][a-z0-9._-]{0,63}$ | — |
EnvironmentManifestProjection
Tenant-scoped immutable manifest plus its observation window.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
content | yes | EnvironmentManifestContent | unknown fields forbidden | — |
environment_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
first_observed_at | yes | string | format date-time | — |
last_observed_at | yes | string | format date-time | — |
manifest_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
EnvironmentObservationState
Type: missing | observed | mixed
Constraints: values missing, observed, mixed
ErrorDetail
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
code | yes | string | pattern ^[a-z][a-z0-9_.-]+$ | — |
message | yes | string | minimum length 1; maximum length 500 | — |
retry_after_ms | no | integer | null | integer: minimum 0.0 | — |
retryable | no | boolean | default false | — |
EventActor
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
id | yes | string | — | — |
type | yes | human | system | attempt | values human, system, attempt | — |
EventId
Type: string
Constraints: pattern ^eve_[0-9a-f]{32}$
EvidenceAttachment
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
live_anchor_id | no | LiveAnchorId | null | LiveAnchorId: pattern ^anc_[0-9a-f]{32}$ | — |
priority | no | integer | minimum -1000.0; maximum 1000.0; default 0 | — |
role | yes | EvidenceRole | values supports, contradicts, derives_from, replicates, contextualizes | — |
EvidenceDependentKind
Type: claim_revision | variable_value
Constraints: values claim_revision, variable_value
EvidenceEdgeProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
created_at | yes | string | format date-time | — |
dependent_id | yes | ClaimRevisionId | VariableValueId | ClaimRevisionId: pattern ^crv_[0-9a-f]{32}$; VariableValueId: pattern ^val_[0-9a-f]{32}$ | — |
dependent_kind | yes | EvidenceDependentKind | values claim_revision, variable_value | — |
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
live_anchor_id | yes | LiveAnchorId | null | LiveAnchorId: pattern ^anc_[0-9a-f]{32}$ | — |
priority | yes | integer | minimum -1000.0; maximum 1000.0 | — |
role | yes | EvidenceRole | values supports, contradicts, derives_from, replicates, contextualizes | — |
EvidenceNeighborhood
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim | yes | ClaimRevisionProjection | unknown fields forbidden | — |
edges | yes | array of EvidenceEdgeProjection | — | — |
evidence | yes | array of EvidenceReferenceProjection | — | — |
truncated | yes | boolean | — | — |
validations | yes | array of ClaimValidationProjection | — | — |
variables | yes | array of VariableValueProjection | — | — |
EvidenceProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact | yes | ArtifactManifest | unknown fields forbidden | — |
content_url | yes | string | — | — |
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
locator | yes | object | — | — |
target_kind | yes | artifact | fixed value artifact | — |
EvidenceRefId
Type: string
Constraints: pattern ^evr_[0-9a-f]{32}$
EvidenceReferenceProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
created_at | yes | string | format date-time | — |
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
locator | yes | object | — | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
retracted_at | yes | string | null | string: format date-time | — |
retraction_reason | yes | string | null | — | — |
state | yes | EvidenceState | values active, retracted | — |
target | yes | EvidenceTarget | ArtifactEvidenceTarget: unknown fields forbidden; BlockRevisionEvidenceTarget: unknown fields forbidden; ExecutionOutputEvidenceTarget: unknown fields forbidden; VariableValueEvidenceTarget: unknown fields forbidden; ClaimRevisionEvidenceTarget: unknown fields forbidden; HumanAssertionEvidenceTarget: unknown fields forbidden | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
EvidenceRole
Type: supports | contradicts | derives_from | replicates | contextualizes
Constraints: values supports, contradicts, derives_from, replicates, contextualizes
EvidenceState
Type: active | retracted
Constraints: values active, retracted
EvidenceTarget
Discriminator: target_kind
Type: ArtifactEvidenceTarget | BlockRevisionEvidenceTarget | ExecutionOutputEvidenceTarget | VariableValueEvidenceTarget | ClaimRevisionEvidenceTarget | HumanAssertionEvidenceTarget Constraints: ArtifactEvidenceTarget: unknown fields forbidden; BlockRevisionEvidenceTarget: unknown fields forbidden; ExecutionOutputEvidenceTarget: unknown fields forbidden; VariableValueEvidenceTarget: unknown fields forbidden; ClaimRevisionEvidenceTarget: unknown fields forbidden; HumanAssertionEvidenceTarget: unknown fields forbidden
ExecuteBlockCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ExecuteBlockPayload | unknown fields forbidden | — |
ExecuteBlockPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
ExecutionId
Type: string
Constraints: pattern ^exe_[0-9a-f]{32}$
ExecutionOutputEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
execution_output_id | yes | ExecutionOutputId | pattern ^out_[0-9a-f]{32}$ | — |
target_kind | yes | execution_output | fixed value execution_output | — |
ExecutionOutputId
Type: string
Constraints: pattern ^out_[0-9a-f]{32}$
ExecutionOutputPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExecutionOutputProjection | — | — |
next_after | no | ExecutionOutputId | null | ExecutionOutputId: pattern ^out_[0-9a-f]{32}$ | — |
ExecutionOutputProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
content_hash | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
display_id | yes | string | null | — | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
execution_output_id | yes | ExecutionOutputId | pattern ^out_[0-9a-f]{32}$ | — |
inline_text | yes | string | null | — | — |
output_type | yes | stream | display_data | update_display_data | execute_result | error | clear_output | values stream, display_data, update_display_data, execute_result, error, clear_output | — |
payload | yes | object | — | — |
sequence | yes | integer | minimum 0.0 | — |
supersedes_output_id | yes | ExecutionOutputId | null | ExecutionOutputId: pattern ^out_[0-9a-f]{32}$ | — |
ExecutionPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExecutionProjection | — | — |
next_after | no | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
ExecutionProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_generation | no | integer | null | integer: minimum 1.0 | — |
attempt_id | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
completed_at | yes | string | null | string: format date-time | — |
created_at | yes | string | format date-time | — |
execution_count | no | integer | null | integer: minimum 0.0 | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
origin | yes | runtime | import | values runtime, import | — |
run_id | no | RunId | null | RunId: pattern ^run_[0-9a-f]{32}$ | — |
runtime_session_generation | no | integer | null | integer: minimum 1.0 | — |
runtime_session_id | no | RuntimeSessionId | null | RuntimeSessionId: pattern ^rts_[0-9a-f]{32}$ | — |
started_at | yes | string | null | string: format date-time | — |
state | yes | queued | running | succeeded | failed | cancelled | imported | values queued, running, succeeded, failed, cancelled, imported | — |
version | yes | integer | minimum 1.0 | — |
ExecutionTicketRequest
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
allowed_host | yes | RuntimeHost | minimum length 1; maximum length 255 | — |
allowed_operations | no | array of object | minimum items 1; maximum items 1; default ["execute"] | — |
allowed_origin | yes | RuntimeOrigin | minimum length 8; maximum length 255 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
audience | no | lumen-execution-v1 | fixed value lumen-execution-v1; default "lumen-execution-v1" | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_execution_generation | yes | integer | minimum 1.0 | — |
expected_runtime_session_generation | yes | integer | minimum 1.0 | — |
lifetime_seconds | no | integer | minimum 1.0; maximum 120.0; default 30 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
runtime_session_id | yes | RuntimeSessionId | pattern ^rts_[0-9a-f]{32}$ | — |
ExperimentBranch
One active or terminal research run projected as an experiment branch.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
accepted_metric_claim | yes | AcceptedMetricClaim | null | AcceptedMetricClaim: unknown fields forbidden | — |
accepted_metric_claim_count | yes | integer | minimum 0.0 | — |
attempt_count | yes | integer | minimum 0.0 | — |
completed_at | yes | string | null | string: format date-time | — |
created_at | yes | string | format date-time | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
environment_digest | yes | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
environment_state | yes | EnvironmentObservationState | values missing, observed, mixed | — |
execution_count | yes | integer | minimum 0.0 | — |
objective | yes | ExperimentObjective | minimum length 12; maximum length 4000 | — |
observed_environment_digest_count | yes | integer | minimum 0.0 | — |
observed_environment_execution_count | yes | integer | minimum 0.0 | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
reproduction_evidence | yes | ReproductionEvidence | null | ReproductionEvidence: unknown fields forbidden | — |
reproduction_state | yes | ReproductionState | values unknown, reproduced, not_reproduced, inconclusive, error | — |
run_count | no | 1 | fixed value 1; default 1 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ExperimentEnvironment
Aggregate observations for one exact canonical runtime environment digest.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
environment_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
execution_count | yes | integer | minimum 1.0 | — |
first_observed_at | yes | string | format date-time | — |
last_observed_at | yes | string | format date-time | — |
manifest | no | EnvironmentManifestProjection | null | EnvironmentManifestProjection: unknown fields forbidden | — |
run_count | yes | integer | minimum 1.0 | — |
ExperimentEnvironmentPage
One digest-keyset page of unique observed runtime environments.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExperimentEnvironment | maximum items 100 | — |
next_after | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
ExperimentObjective
Type: string Constraints: minimum length 12; maximum length 4000
ExperimentPage
One ID-keyset page of active or terminal experiment branches.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExperimentBranch | maximum items 100 | — |
next_after | no | RunId | null | RunId: pattern ^run_[0-9a-f]{32}$ | — |
ExtensionAuthor
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
name | yes | string | minimum length 1; maximum length 200 | — |
url | no | string | null | string: maximum length 500 | — |
ExtensionCapabilityDiff
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
added_skills | no | array of SkillName | maximum items 128; default [] | — |
added_tools | no | array of string | maximum items 512; default [] | — |
approval_required | no | True | fixed value True; default true | — |
approval_required_tools | no | array of string | maximum items 512; default [] | — |
changed_skills | no | array of SkillName | maximum items 128; default [] | — |
changed_tools | no | array of string | maximum items 512; default [] | — |
from_version_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
mutating_tools | no | array of string | maximum items 512; default [] | — |
network_hosts | no | array of string | maximum items 64; default [] | — |
removed_skills | no | array of SkillName | maximum items 128; default [] | — |
removed_tools | no | array of string | maximum items 512; default [] | — |
secret_references | no | array of string | maximum items 128; default [] | — |
to_version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
unsupported_surfaces | no | array of UnsupportedExtensionSurface | maximum items 128; default [] | — |
ExtensionCapabilityDiffPreview
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
capability_diff | yes | ExtensionCapabilityDiff | unknown fields forbidden | — |
capability_diff_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
current_version_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
extension_id | yes | ExtensionId | pattern ^ext_[0-9a-f]{32}$ | — |
target_version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
ExtensionCatalogEntry
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
capability_diff | yes | ExtensionCapabilityDiff | unknown fields forbidden | — |
capability_diff_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
extension_id | yes | ExtensionId | pattern ^ext_[0-9a-f]{32}$ | — |
mcp_servers | no | array of RemoteMcpServer | maximum items 32; default [] | — |
metadata | yes | ExtensionMetadata | unknown fields forbidden | — |
review_state | yes | ExtensionReviewState | values review_required, quarantined | — |
skills | no | array of AgentSkillVersion | maximum items 128; default [] | — |
source | yes | ExtensionSource | unknown fields forbidden | — |
tools | no | array of ExtensionTool | maximum items 512; default [] | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
ExtensionCatalogPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExtensionCatalogEntry | maximum items 100 | — |
next_after | no | ExtensionId | null | ExtensionId: pattern ^ext_[0-9a-f]{32}$ | — |
ExtensionCommandAccepted
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
event_sequence | yes | integer | minimum 1.0 | — |
installation_id | yes | ExtensionInstallationId | pattern ^ins_[0-9a-f]{32}$ | — |
installation_version | yes | integer | minimum 1.0 | — |
status | no | accepted | fixed value accepted; default "accepted" | — |
ExtensionEcosystem
Type: agent_plugins | codex | claude_code
Constraints: values agent_plugins, codex, claude_code
ExtensionId
Type: string
Constraints: pattern ^ext_[0-9a-f]{32}$
ExtensionInstallationId
Type: string
Constraints: pattern ^ins_[0-9a-f]{32}$
ExtensionInstallationPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ExtensionInstallationProjection | maximum items 100 | — |
next_after | no | ExtensionInstallationId | null | ExtensionInstallationId: pattern ^ins_[0-9a-f]{32}$ | — |
ExtensionInstallationProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approved_capability_diff | yes | ExtensionCapabilityDiff | unknown fields forbidden | — |
capability_diff_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
extension_id | yes | ExtensionId | pattern ^ext_[0-9a-f]{32}$ | — |
extension_version | yes | string | minimum length 1; maximum length 64 | — |
installation_id | yes | ExtensionInstallationId | pattern ^ins_[0-9a-f]{32}$ | — |
secret_requirements | no | array of ExtensionSecretRequirementProjection | maximum items 128; default [] | — |
tools | no | array of InstalledExtensionToolPolicy | maximum items 512; default [] | — |
updated_at | yes | string | format date-time | — |
version | yes | integer | minimum 1.0 | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ExtensionMetadata
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
author | no | ExtensionAuthor | null | ExtensionAuthor: unknown fields forbidden | — |
description | yes | string | minimum length 1; maximum length 2000 | — |
display_name | yes | string | minimum length 1; maximum length 200 | — |
homepage | no | string | null | string: maximum length 500 | — |
keywords | no | array of string | maximum items 32; default [] | — |
license | yes | string | minimum length 1; maximum length 128 | — |
name | yes | PluginName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9.-]{0,62}[a-z0-9])?$ | — |
repository | no | string | null | string: maximum length 500 | — |
version | yes | string | minimum length 1; maximum length 64 | — |
ExtensionReviewState
Type: review_required | quarantined
Constraints: values review_required, quarantined
ExtensionSecretBindingInput
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
reference_key | yes | string | pattern ^[A-Z][A-Z0-9_]{1,127}$ | — |
secret_reference_id | yes | SecretReferenceId | pattern ^srf_[0-9a-f]{32}$ | — |
server_name | yes | McpName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$ | — |
ExtensionSecretRequirementProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
configured | yes | boolean | — | — |
destination | yes | string | pattern ^header:[A-Za-z0-9-]{1,100}$ | — |
reference_key | yes | string | pattern ^[A-Z][A-Z0-9_]{1,127}$ | — |
server_name | yes | McpName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$ | — |
ExtensionSource
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
archive_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
ecosystem | yes | ExtensionEcosystem | values agent_plugins, codex, claude_code | — |
locator | yes | string | minimum length 1; maximum length 500 | — |
revision | yes | SourceRevision | pattern ^(?:git:[0-9a-f]{40}|sha256:[0-9a-f]{64})$ | — |
source_kind | yes | pinned_git | reviewed_local | values pinned_git, reviewed_local | — |
ExtensionTool
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approval_required | no | True | fixed value True; default true | — |
description | yes | string | minimum length 1; maximum length 2000 | — |
input_schema | yes | object | — | — |
native_name | yes | string | minimum length 1; maximum length 128 | — |
policy | no | disabled | fixed value disabled; default "disabled" | — |
risk_class | no | external_side_effect | fixed value external_side_effect; default "external_side_effect" | — |
server_name | yes | McpName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$ | — |
title | yes | string | minimum length 1; maximum length 200 | — |
tool_id | yes | string | pattern ^[a-z0-9][a-z0-9_.:-]{0,127}$ | — |
ExtensionToolPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
extension_id | yes | ExtensionId | pattern ^ext_[0-9a-f]{32}$ | — |
items | yes | array of ExtensionTool | maximum items 512 | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
FinalizeProjectDeletionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | FinalizeProjectDeletionPayload | unknown fields forbidden | — |
FinalizeProjectDeletionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
cleanup_receipt_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
deletion_generation | yes | integer | minimum 1.0 | — |
expected_deletion_version | yes | integer | minimum 1.0 | — |
expected_project_version | yes | integer | minimum 1.0 | — |
object_purge_status | yes | complete | not_required | values complete, not_required | — |
purge_plan_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
HandoffKind
Type: artifact | variable
Constraints: values artifact, variable
HandoffRequirement
One named, typed output a dependency must make available.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
classification | yes | DataClassification | values public, internal, confidential, restricted | — |
kind | yes | HandoffKind | values artifact, variable | — |
schema_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
slot | yes | HandoffSlot | minimum length 1; maximum length 128 | — |
HandoffSlot
Type: string Constraints: minimum length 1; maximum length 128
HealthReport
Stable redacted report safe for health endpoints and structured logs.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
checks | yes | array of OperationalCheck | — | — |
last_successful_outbox_cursor | no | string | null | string: maximum length 128 | — |
last_successful_reconciliation_at | no | string | null | string: format date-time | — |
ready | yes | boolean | — | — |
role | yes | app | worker | values app, worker | — |
schema_version | no | 1 | fixed value 1; default 1 | — |
status | yes | ok | degraded | unavailable | values ok, degraded, unavailable | — |
HumanAssertionEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
assertion | yes | string | minimum length 1; maximum length 8000 | — |
target_kind | yes | human_assertion | fixed value human_assertion | — |
InferenceProfileSummary
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
input_micros_per_million | yes | integer | minimum 0.0 | — |
max_input_tokens | yes | integer | minimum 1.0 | — |
max_output_tokens | yes | integer | minimum 1.0 | — |
model_id | yes | string | minimum length 1; maximum length 128 | — |
output_micros_per_million | yes | integer | minimum 0.0 | — |
profile_id | yes | string | minimum length 6; maximum length 128 | — |
provider | yes | openai | anthropic | values openai, anthropic | — |
retention | yes | provider_default | zero_retention_verified | values provider_default, zero_retention_verified | — |
supports_parallel_tools | yes | boolean | — | — |
supports_reasoning_summaries | yes | boolean | — | — |
supports_tools | yes | boolean | — | — |
InlineVariableValue
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
value | yes | JsonValue | — | — |
InstallExtensionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | InstallExtensionPayload | unknown fields forbidden | — |
InstallExtensionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_installation_version | no | integer | null | integer: minimum 1.0 | — |
extension_id | yes | ExtensionId | pattern ^ext_[0-9a-f]{32}$ | — |
presented_capability_diff_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
secret_bindings | no | array of ExtensionSecretBindingInput | maximum items 128; default [] | — |
version_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
InstalledExtensionToolPolicy
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approved_at | no | string | null | string: format date-time | — |
approved_capability_diff_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
state | yes | disabled | enabled | values disabled, enabled | — |
tool | yes | ExtensionTool | unknown fields forbidden | — |
updated_at | yes | string | format date-time | — |
version | yes | integer | minimum 1.0 | — |
InteractionRequestId
Type: string
Constraints: pattern ^int_[0-9a-f]{32}$
InterruptAttemptCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | InterruptAttemptPayload | unknown fields forbidden | — |
InterruptAttemptPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_attempt_version | yes | integer | minimum 1.0 | — |
JsonValue
Type: object Constraints: —
KnowledgeActor
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
actor_id | yes | string | minimum length 1; maximum length 128 | — |
actor_type | yes | KnowledgeAuthorType | values human, attempt, system, import | — |
KnowledgeAuthorType
Type: human | attempt | system | import
Constraints: values human, attempt, system, import
LiveAnchorId
Type: string
Constraints: pattern ^anc_[0-9a-f]{32}$
LiveAnchorProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
anchor_type | yes | LiveAnchorType | values variable, evidence | — |
created_at | yes | string | format date-time | — |
current_evidence_ref_id | yes | EvidenceRefId | null | EvidenceRefId: pattern ^evr_[0-9a-f]{32}$ | — |
description | yes | string | — | — |
key | yes | string | — | — |
live_anchor_id | yes | LiveAnchorId | pattern ^anc_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
selected_at | yes | string | null | string: format date-time | — |
version | yes | integer | minimum 1.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
LiveAnchorType
Type: variable | evidence
Constraints: values variable, evidence
LocalGatewayBridgeTokenRequest
The only caller-controlled bridge fields.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
gateway_id | yes | LocalGatewayId | pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{7,63}$ | — |
ttl_seconds | yes | integer | minimum 300.0; maximum 900.0 | — |
LocalGatewayBridgeTokenResponse
A short-lived bearer returned once and never cached or persisted.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
event_ingress_path | no | /v1/local-gateway/events | fixed value /v1/local-gateway/events; default "/v1/local-gateway/events" | — |
expires_at | yes | string | format date-time | — |
gateway_id | yes | LocalGatewayId | pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{7,63}$ | — |
issued_at | yes | string | format date-time | — |
token | yes | string | minimum length 1; maximum length 4096 | — |
LocalGatewayId
Type: string
Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._:-]{7,63}$
McpName
Type: string
Constraints: minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$
McpSecretReference
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
destination | yes | string | pattern ^header:[A-Za-z0-9-]{1,100}$ | — |
reference_key | yes | string | pattern ^[A-Z][A-Z0-9_]{1,127}$ | — |
MessageEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
content | yes | string | — | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | message.started | message.delta | message.completed | values message.started, message.delta, message.completed | — |
message_id | yes | string | — | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
MessageSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
kind | yes | message | fixed value message | — |
provider_sequence | yes | integer | minimum 0.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
MetricText
Type: string Constraints: minimum length 1; maximum length 65536
MetricTitle
Type: string Constraints: minimum length 1; maximum length 240
MoveBlockCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | MoveBlockPayload | unknown fields forbidden | — |
MoveBlockPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
after_block_id | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
before_block_id | no | BlockId | null | BlockId: pattern ^blk_[0-9a-f]{32}$ | — |
expected_structure_version | yes | integer | minimum 1.0 | — |
OpeningId
Type: string
Constraints: pattern ^(?:blk|out|tsk|eve|clm|art)_[0-9a-f]{32}$
OperationalCheck
One bounded status without endpoints, credentials, or raw failures.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
code | yes | string | pattern ^[a-z][a-z0-9._-]{0,95}$ | — |
mode | no | string | null | string: pattern ^[a-z0-9][a-z0-9._-]{0,63}$ | — |
name | yes | string | pattern ^[a-z][a-z0-9._-]{0,63}$ | — |
required | yes | boolean | — | — |
status | yes | ok | unconfigured | unavailable | stale | values ok, unconfigured, unavailable, stale | — |
OutputSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
execution_output_id | yes | ExecutionOutputId | pattern ^out_[0-9a-f]{32}$ | — |
kind | yes | output | fixed value output | — |
PauseReason
Type: string Constraints: minimum length 1; maximum length 1000
PauseRunCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | PauseRunPayload | unknown fields forbidden | — |
PauseRunPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
reason | yes | PauseReason | minimum length 1; maximum length 1000 | — |
PauseScheduleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | PauseSchedulePayload | unknown fields forbidden | — |
PauseSchedulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_version | yes | integer | minimum 1.0 | — |
reason | yes | PauseReason | minimum length 1; maximum length 1000 | — |
PauseTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | PauseTaskPayload | unknown fields forbidden | — |
PauseTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
reason | yes | PauseReason | minimum length 1; maximum length 1000 | — |
PlanEdgeSpec
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
handoff | yes | DependencyHandoff | unknown fields forbidden | — |
predecessor_key | yes | TaskKey | pattern ^[a-z][a-z0-9_.-]{0,63}$ | — |
reason | yes | DependencyReason | minimum length 1; maximum length 1000 | — |
successor_key | yes | TaskKey | pattern ^[a-z][a-z0-9_.-]{0,63}$ | — |
PlanProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
edges | yes | array of TaskEdgeProjection | — | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
revision | yes | integer | minimum 1.0 | — |
status | yes | draft | approved | superseded | values draft, approved, superseded | — |
summary | yes | string | — | — |
tasks | yes | array of TaskProjection | — | — |
PlanRevisionAccepted
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
first_event_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
revision | yes | integer | minimum 1.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
run_version | yes | integer | minimum 1.0 | — |
status | no | accepted | fixed value accepted; default "accepted" | — |
task_ids | yes | array of array of object | — | — |
PlanRevisionSpec
One complete, bounded DAG proposal validated before any row is written.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
edges | no | array of PlanEdgeSpec | maximum items 1024; default [] | — |
summary | yes | string | minimum length 1; maximum length 4000 | — |
tasks | yes | array of PlanTaskSpec | minimum items 1; maximum items 256 | — |
PlanTaskSpec
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
acceptance_criteria | yes | array of AcceptanceCriterion | minimum items 1; maximum items 20 | — |
allowed_tool_ids | no | array of TaskToolId | minimum items 1; maximum items 32; default ["workspace.read_file", "workspace.write_file", "workspace.delete_file", "workspace.publish_change_set", "shell.exec", "skills.read", "references.read", "subagents.delegate", "notebook.edit_block", "notebook.execute_block", "search_web", "fetch_source", "github.read_issue", "github.create_issue_comment", "handoffs.read_artifact", "research.propose_deliverable", "tasks.list", "tasks.revise_plan", "tasks.retry", "agents.message"] | Compatibility metadata only; the server owns attempt tools. |
assignment_policy | no | TaskAssignmentPolicy | values automatic, operator; default "automatic" | — |
concurrency_class | no | TaskConcurrencyClass | values parallel, exclusive; default "parallel" | — |
estimated_cost_micros | no | integer | minimum 0.0; maximum 10000000000.0; default 0 | — |
execution_profile | no | TaskExecutionProfile | values planning, research, verification; default "research" | — |
hard_budget_micros | no | integer | minimum 0.0; maximum 10000000000.0; default 0 | — |
key | yes | TaskKey | pattern ^[a-z][a-z0-9_.-]{0,63}$ | — |
objective | yes | TaskObjective | minimum length 1; maximum length 4000 | — |
priority | no | integer | minimum -1000.0; maximum 1000.0; default 0 | — |
required_environment_capabilities | no | array of EnvironmentCapability | minimum items 1; maximum items 8; default ["pi_agent", "python_notebook", "shell", "subagents"] | Compatibility metadata only; the server owns attempt environments. |
revision_action | no | TaskRevisionAction | values new, retained, replanned; default "new" | — |
source_task_id | no | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
starter_context | no | string | maximum length 16384; default "" | — |
title | yes | TaskTitle | minimum length 1; maximum length 240 | — |
PlanVersionId
Type: string
Constraints: pattern ^pln_[0-9a-f]{32}$
PluginName
Type: string
Constraints: minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9.-]{0,62}[a-z0-9])?$
PolicyIdentifier
Type: string
Constraints: pattern ^[a-z][a-z0-9_.:-]{0,127}$
ProductSearchHit
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
created_at | yes | string | format date-time | — |
excerpt | yes | string | minimum length 1; maximum length 2000 | — |
kind | yes | ProductSearchKind | values block, output, task, message, attempt_event, claim, artifact | — |
locator | yes | ProductSearchLocator | BlockSearchLocator: unknown fields forbidden; OutputSearchLocator: unknown fields forbidden; TaskSearchLocator: unknown fields forbidden; MessageSearchLocator: unknown fields forbidden; AttemptEventSearchLocator: unknown fields forbidden; ClaimSearchLocator: unknown fields forbidden; ArtifactSearchLocator: unknown fields forbidden | — |
opening_id | yes | OpeningId | pattern ^(?:blk|out|tsk|eve|clm|art)_[0-9a-f]{32}$ | — |
relevance | yes | number | minimum 0.0 | — |
title | yes | string | minimum length 1; maximum length 500 | — |
ProductSearchKind
Type: block | output | task | message | attempt_event | claim | artifact
Constraints: values block, output, task, message, attempt_event, claim, artifact
ProductSearchLocator
Discriminator: kind
Type: BlockSearchLocator | OutputSearchLocator | TaskSearchLocator | MessageSearchLocator | AttemptEventSearchLocator | ClaimSearchLocator | ArtifactSearchLocator Constraints: BlockSearchLocator: unknown fields forbidden; OutputSearchLocator: unknown fields forbidden; TaskSearchLocator: unknown fields forbidden; MessageSearchLocator: unknown fields forbidden; AttemptEventSearchLocator: unknown fields forbidden; ClaimSearchLocator: unknown fields forbidden; ArtifactSearchLocator: unknown fields forbidden
ProductSearchPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ProductSearchHit | — | — |
kinds | yes | array of ProductSearchKind | — | — |
query | yes | string | minimum length 1; maximum length 200 | — |
truncated | yes | boolean | — | — |
ProjectDeletionProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_count | yes | integer | minimum 0.0 | — |
cleanup_blockers | yes | object | — | — |
cleanup_result | yes | object | — | — |
deletion_generation | yes | integer | minimum 1.0 | — |
deletion_version | yes | integer | minimum 1.0 | — |
export_acknowledged_at | no | string | null | string: format date-time | — |
export_manifest_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
export_required | yes | boolean | — | — |
finalized_at | no | string | null | string: format date-time | — |
lifecycle_state | yes | export_pending | deletion_pending | tombstoned | values export_pending, deletion_pending, tombstoned | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
project_version | yes | integer | minimum 1.0 | — |
purge_eligible_artifact_count | yes | integer | minimum 0.0 | — |
purge_plan_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
referenced_artifact_count | yes | integer | minimum 0.0 | — |
requested_at | yes | string | format date-time | — |
state | yes | export_pending | deletion_pending | finalized | values export_pending, deletion_pending, finalized | — |
updated_at | yes | string | format date-time | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ProjectId
Type: string
Constraints: pattern ^prj_[0-9a-f]{32}$
ProjectImportId
Type: string
Constraints: pattern ^imp_[0-9a-f]{32}$
ProjectName
Type: string Constraints: minimum length 1; maximum length 200
ProjectPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ProjectProjection | maximum items 100 | — |
next_after | no | ProjectId | null | ProjectId: pattern ^prj_[0-9a-f]{32}$ | — |
ProjectProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
name | yes | string | — | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
settings | yes | ProjectSettings | unknown fields forbidden | — |
version | yes | integer | minimum 1.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ProjectSettings
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
inspector_collapsed | no | boolean | default false | — |
inspector_width | no | integer | minimum 320.0; maximum 480.0; default 360 | — |
navigator_collapsed | no | boolean | default false | — |
navigator_width | no | integer | minimum 216.0; maximum 384.0; default 248 | — |
theme | no | system | light | dark | values system, light, dark; default "system" | — |
ProjectWorkspaceChangeSetProjection
Verified review projection derived only from immutable artifacts and events.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
candidate_manifest | yes | WorkspaceManifest | unknown fields forbidden | — |
change_set_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
change_set_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
current_workspace_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
current_workspace_version | yes | integer | minimum 0.0 | — |
manifest | yes | WorkspaceChangeSetManifest | unknown fields forbidden | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
status | yes | reviewable | stale | accepted | values reviewable, stale, accepted | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
PtyTicketRequest
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
allowed_host | yes | RuntimeHost | minimum length 1; maximum length 255 | — |
allowed_operations | yes | array of stdin | resize | signal | status | minimum items 1; maximum items 4 | — |
allowed_origin | yes | RuntimeOrigin | minimum length 8; maximum length 255 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
audience | no | lumen-pty-v1 | fixed value lumen-pty-v1; default "lumen-pty-v1" | — |
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_runtime_session_generation | yes | integer | minimum 1.0 | — |
lifetime_seconds | no | integer | minimum 1.0; maximum 120.0; default 30 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
runtime_session_id | yes | RuntimeSessionId | pattern ^rts_[0-9a-f]{32}$ | — |
ReasoningSummaryEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | reasoning.summary | fixed value reasoning.summary | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
summary | yes | string | — | — |
RecordClaimValidationCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RecordClaimValidationPayload | unknown fields forbidden | — |
RecordClaimValidationPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
expected_claim_version | yes | integer | minimum 1.0 | — |
input_manifest | yes | object | — | — |
method | yes | ValidationMethod | values rerun, fresh_sandbox_replication, independent_implementation, leakage_check, perturbation, statistical_check, data_quality_check, contradiction_search, raw_metric_check | — |
outcome | yes | ValidationOutcome | values passed, failed, inconclusive, error | — |
result_evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
summary | yes | string | minimum length 1; maximum length 8000 | — |
verifying_attempt_id | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
verifying_task_id | no | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
RejectWorkspaceChangeSetCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RejectWorkspaceChangeSetPayload | unknown fields forbidden | — |
RejectWorkspaceChangeSetPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
change_set_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
change_set_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
expected_workspace_version | yes | integer | minimum 0.0 | — |
reason | yes | string | minimum length 1; maximum length 2000 | — |
RemoteMcpServer
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
enabled | no | False | fixed value False; default false | — |
endpoint | yes | string | minimum length 1; maximum length 2048 | — |
name | yes | McpName | minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$ | — |
network_host | yes | string | pattern ^[a-z0-9](?:[a-z0-9.-]{0,251}[a-z0-9])?$ | — |
secret_references | no | array of McpSecretReference | maximum items 32; default [] | — |
transport | no | streamable_http | fixed value streamable_http; default "streamable_http" | — |
RemoveTaskDependencyCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RemoveTaskDependencyPayload | unknown fields forbidden | — |
RemoveTaskDependencyPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
predecessor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
successor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
ReplaceScopedRuleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ReplaceScopedRulePayload | unknown fields forbidden | — |
ReplaceScopedRulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
enabled | yes | boolean | — | — |
expected_revision | yes | integer | minimum 1.0 | — |
instructions | yes | RuleInstructions | minimum length 1; maximum length 8192 | — |
title | yes | RuleTitle | minimum length 1; maximum length 200 | — |
ReproductionEvidence
The latest active rerun/replication validation for an exact metric revision.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
claim_validation_id | yes | ClaimValidationId | pattern ^vld_[0-9a-f]{32}$ | — |
content_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
method | yes | ReproductionMethod | values rerun, fresh_sandbox_replication | — |
outcome | yes | ReproductionOutcome | values passed, failed, inconclusive, error | — |
result_evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
summary | yes | ValidationSummary | minimum length 1; maximum length 8000 | — |
verifying_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
verifying_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
ReproductionMethod
Type: rerun | fresh_sandbox_replication
Constraints: values rerun, fresh_sandbox_replication
ReproductionOutcome
Type: passed | failed | inconclusive | error
Constraints: values passed, failed, inconclusive, error
ReproductionState
Type: unknown | reproduced | not_reproduced | inconclusive | error
Constraints: values unknown, reproduced, not_reproduced, inconclusive, error
RequestProjectDeletionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RequestProjectDeletionPayload | unknown fields forbidden | — |
RequestProjectDeletionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_project_version | yes | integer | minimum 1.0 | — |
export_policy | yes | require_export | skip_export | values require_export, skip_export | — |
ResearchObjective
Type: string Constraints: minimum length 12; maximum length 4000
ResearchReference
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
kind | yes | ResearchReferenceKind | values project, run, task, document, claim, artifact | — |
label | yes | string | minimum length 1; maximum length 240 | — |
object_id | yes | string | minimum length 36; maximum length 36 | — |
ResearchReferenceKind
Type: project | run | task | document | claim | artifact
Constraints: values project, run, task, document, claim, artifact
ResearchResult
The summary-capable result returned by the additive result endpoint.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact | yes | StoryArtifact | unknown fields forbidden | — |
attempt | yes | StoryAttempt | unknown fields forbidden | — |
claim | yes | StoryClaim | null | StoryClaim: unknown fields forbidden | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
notebook | yes | StoryBlock | null | StoryBlock: unknown fields forbidden | — |
objective | yes | string | — | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task | yes | StoryTask | unknown fields forbidden | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
writeup | yes | StoryWriteup | null | StoryWriteup: unknown fields forbidden | — |
ResearchStory
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact | yes | StoryArtifact | unknown fields forbidden | — |
attempt | yes | StoryAttempt | unknown fields forbidden | — |
claim | yes | StoryClaim | unknown fields forbidden | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
notebook | yes | StoryBlock | unknown fields forbidden | — |
objective | yes | string | — | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task | yes | StoryTask | unknown fields forbidden | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
writeup | yes | StoryWriteup | unknown fields forbidden | — |
ResolveToolApprovalCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ResolveToolApprovalPayload | unknown fields forbidden | — |
ResolveToolApprovalPayload
An exact, stale-safe human decision over one immutable tool request.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
decision | yes | allow | deny | values allow, deny | — |
expected_approval_id | yes | InteractionRequestId | pattern ^int_[0-9a-f]{32}$ | — |
expected_argument_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_policy_version | yes | integer | minimum 1.0 | — |
expected_request_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
expected_version | yes | integer | minimum 1.0 | — |
ResumeRunCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ResumeRunPayload | unknown fields forbidden | — |
ResumeRunPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
ResumeScheduleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ResumeSchedulePayload | unknown fields forbidden | — |
ResumeSchedulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_version | yes | integer | minimum 1.0 | — |
ResumeTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ResumeTaskPayload | unknown fields forbidden | — |
ResumeTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
RetentionCode
Type: string
Constraints: pattern ^[a-z][a-z0-9_.-]{1,127}$
RetentionDataClass
Type: transient_stream_chunks | ordinary_project_state | immutable_evidence_artifacts | sensitive_source_data | provider_prompts_responses | audit_security_events | deleted_export_pending
Constraints: values transient_stream_chunks, ordinary_project_state, immutable_evidence_artifacts, sensitive_source_data, provider_prompts_responses, audit_security_events, deleted_export_pending
RetractEvidenceCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RetractEvidencePayload | unknown fields forbidden | — |
RetractEvidencePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
reason | yes | string | minimum length 1; maximum length 2000 | — |
RetractVariableValueCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RetractVariableValuePayload | unknown fields forbidden | — |
RetractVariableValuePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
reason | yes | string | minimum length 1; maximum length 2000 | — |
variable_value_id | yes | VariableValueId | pattern ^val_[0-9a-f]{32}$ | — |
RetryTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | RetryTaskPayload | unknown fields forbidden | — |
RetryTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
reason | yes | string | minimum length 1; maximum length 1000 | — |
ReviewClaimCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | ReviewClaimPayload | unknown fields forbidden | — |
ReviewClaimPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
decision | yes | submit | accept | reject | challenge | retract | values submit, accept, reject, challenge, retract | — |
expected_claim_version | yes | integer | minimum 1.0 | — |
reason | yes | string | minimum length 1; maximum length 2000 | — |
RuleCommandAccepted
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
content_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
revision | yes | integer | minimum 1.0 | — |
rule_id | yes | RuleId | pattern ^rul_[0-9a-f]{32}$ | — |
status | no | accepted | fixed value accepted; default "accepted" | — |
RuleId
Type: string
Constraints: pattern ^rul_[0-9a-f]{32}$
RuleInstructions
Type: string Constraints: minimum length 1; maximum length 8192
RuleScopeKind
Type: workspace | project
Constraints: values workspace, project
RuleTitle
Type: string Constraints: minimum length 1; maximum length 200
RunAttemptHistoryItem
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
admitted_budget_micros | yes | integer | minimum 0.0 | — |
attempt_generation | yes | integer | minimum 1.0 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
attempt_number | yes | integer | minimum 1.0 | — |
created_at | yes | string | format date-time | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
finished_at | yes | string | null | string: format date-time | — |
is_current_generation | yes | boolean | — | — |
is_current_plan_revision | yes | boolean | — | — |
is_latest_task_attempt | yes | boolean | — | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
plan_revision | yes | integer | minimum 1.0 | — |
result_digest | no | string | null | string: pattern ^sha256:[0-9a-f]{64}$ | — |
result_output_count | yes | integer | minimum 0.0 | — |
started_at | yes | string | null | string: format date-time | — |
summary | yes | string | null | — | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
task_title | yes | string | — | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
RunAttemptHistoryPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of RunAttemptHistoryItem | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
RunDetailProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
plan | yes | PlanProjection | unknown fields forbidden | — |
run | yes | RunProjection | unknown fields forbidden | — |
RunId
Type: string
Constraints: pattern ^run_[0-9a-f]{32}$
RunPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of RunProjection | — | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | RunId | null | RunId: pattern ^run_[0-9a-f]{32}$ | — |
RunProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
completed_at | yes | string | null | string: format date-time | — |
created_at | yes | string | format date-time | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
generation | yes | integer | minimum 1.0 | — |
objective | yes | string | — | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
plan_revision | yes | integer | minimum 1.0 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
references | no | array of ResearchReference | default [] | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
version | yes | integer | minimum 1.0 | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
RuntimeControlTicketRequest
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
allowed_host | yes | RuntimeHost | minimum length 1; maximum length 255 | — |
allowed_operations | yes | array of interrupt | status | minimum items 1; maximum items 2 | — |
allowed_origin | yes | RuntimeOrigin | minimum length 8; maximum length 255 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
audience | no | lumen-runtime-control-v1 | fixed value lumen-runtime-control-v1; default "lumen-runtime-control-v1" | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_execution_generation | yes | integer | minimum 1.0 | — |
expected_runtime_session_generation | yes | integer | minimum 1.0 | — |
lifetime_seconds | no | integer | minimum 1.0; maximum 120.0; default 30 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
runtime_session_id | yes | RuntimeSessionId | pattern ^rts_[0-9a-f]{32}$ | — |
RuntimeHost
Type: string Constraints: minimum length 1; maximum length 255
RuntimeOrigin
Type: string Constraints: minimum length 8; maximum length 255
RuntimeSessionId
Type: string
Constraints: pattern ^rts_[0-9a-f]{32}$
RuntimeTicketAudience
Type: lumen-execution-v1 | lumen-pty-v1 | lumen-runtime-control-v1
Constraints: values lumen-execution-v1, lumen-pty-v1, lumen-runtime-control-v1
RuntimeTicketGrant
The only browser-visible bearer copy; response caching is forbidden.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
scope | yes | RuntimeTicketScope | unknown fields forbidden | — |
token | yes | string | minimum length 1; maximum length 256 | — |
RuntimeTicketOperation
Type: execute | interrupt | resize | signal | status | stdin
Constraints: values execute, interrupt, resize, signal, status, stdin
RuntimeTicketScope
The exact canonical authority committed beside one opaque token hash.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
actor_id | yes | string | format uuid | — |
allowed_host | yes | RuntimeHost | minimum length 1; maximum length 255 | — |
allowed_operations | yes | array of RuntimeTicketOperation | minimum items 1; maximum items 4 | — |
allowed_origin | yes | RuntimeOrigin | minimum length 8; maximum length 255 | — |
attempt_generation | yes | integer | minimum 1.0 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
audience | yes | RuntimeTicketAudience | values lumen-execution-v1, lumen-pty-v1, lumen-runtime-control-v1 | — |
block_revision_id | no | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
execution_generation | no | integer | null | integer: minimum 1.0 | — |
execution_id | no | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
expires_at | yes | string | format date-time | — |
input_manifest_hash | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
issued_at | yes | string | format date-time | — |
policy_version | yes | integer | minimum 1.0 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
revocation_version | yes | integer | minimum 1.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
runtime_session_generation | yes | integer | minimum 1.0 | — |
runtime_session_id | yes | RuntimeSessionId | pattern ^rts_[0-9a-f]{32}$ | — |
source_hash | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
RuntimeVersion
Type: string
Constraints: maximum length 64; pattern ^[0-9]+(?:\.[0-9]+){1,3}(?:[a-z0-9.+-]*)?$
SaveBlockRevisionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | SaveBlockRevisionPayload | unknown fields forbidden | — |
SaveBlockRevisionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
base_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
expected_structure_version | yes | integer | minimum 1.0 | — |
language | no | BlockLanguage | null | BlockLanguage: minimum length 1; maximum length 64 | — |
metadata | no | object | — | — |
source | yes | BlockSource | maximum length 1048576 | — |
ScheduleDeletionReason
Type: string Constraints: minimum length 1; maximum length 1000
ScheduleDesiredState
Type: active | paused | deleted
Constraints: values active, paused, deleted
ScheduleDetailProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
schedule | yes | ScheduleProjection | unknown fields forbidden | — |
ScheduleId
Type: string
Constraints: pattern ^sch_[0-9a-f]{32}$
ScheduleOverlapPolicy
Type: skip | buffer_one
Constraints: values skip, buffer_one
SchedulePage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ScheduleProjection | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | ScheduleId | null | ScheduleId: pattern ^sch_[0-9a-f]{32}$ | — |
ScheduleProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
applied_version | no | integer | null | integer: minimum 1.0 | — |
created_at | yes | string | format date-time | — |
deleted_at | yes | string | null | string: format date-time | — |
desired_state | yes | ScheduleDesiredState | values active, paused, deleted | — |
elapsed | yes | boolean | — | — |
last_error_code | no | string | null | string: pattern ^[a-z][a-z0-9_.:-]{0,127}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
schedule_id | yes | ScheduleId | pattern ^sch_[0-9a-f]{32}$ | — |
sync_state | yes | ScheduleSyncState | values pending, applied, rejected | — |
template | yes | ScheduleRunTemplate | unknown fields forbidden | — |
timing | yes | ScheduleTiming | unknown fields forbidden | — |
updated_at | yes | string | format date-time | — |
version | yes | integer | minimum 1.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ScheduleRunTemplate
Frozen, explicit inputs copied into each ordinary scheduled run.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
dataset_artifact_ids | no | array of ArtifactId | maximum items 32; default [] | — |
max_cost_micros | no | integer | minimum 0.0; maximum 10000000000.0; default 15512000 | — |
model_profile_id | yes | PolicyIdentifier | pattern ^[a-z][a-z0-9_.:-]{0,127}$ | — |
notification_policy | yes | none | fixed value none | — |
objective | yes | ResearchObjective | minimum length 12; maximum length 4000 | — |
overlap_policy | yes | ScheduleOverlapPolicy | values skip, buffer_one | — |
title | yes | ScheduleTitle | minimum length 1; maximum length 200 | — |
ScheduleSyncState
Type: pending | applied | rejected
Constraints: values pending, applied, rejected
ScheduleTiming
One UTC-safe deferred instant or an interval anchored to an instant.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
ends_at | no | string | null | string: format date-time | — |
every_seconds | no | integer | null | integer: minimum 60.0; maximum 31536000.0 | — |
starts_at | yes | string | format date-time | — |
ScheduleTitle
Type: string Constraints: minimum length 1; maximum length 200
ScopedRulePage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ScopedRuleVersion | maximum items 100 | — |
next_after | no | RuleId | null | RuleId: pattern ^rul_[0-9a-f]{32}$ | — |
ScopedRuleVersion
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
content_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
enabled | yes | boolean | — | — |
instructions | yes | RuleInstructions | minimum length 1; maximum length 8192 | — |
project_id | no | ProjectId | null | ProjectId: pattern ^prj_[0-9a-f]{32}$ | — |
revision | yes | integer | minimum 1.0 | — |
rule_id | yes | RuleId | pattern ^rul_[0-9a-f]{32}$ | — |
scope_kind | yes | RuleScopeKind | values workspace, project | — |
title | yes | RuleTitle | minimum length 1; maximum length 200 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
SecretReferenceId
Type: string
Constraints: pattern ^srf_[0-9a-f]{32}$
SelectLiveAnchorCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | SelectLiveAnchorPayload | unknown fields forbidden | — |
SelectLiveAnchorPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
expected_anchor_version | yes | integer | minimum 1.0 | — |
reason | yes | string | minimum length 1; maximum length 2000 | — |
SendAgentMessageCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | SendAgentMessagePayload | unknown fields forbidden | — |
SendAgentMessagePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
content | yes | AgentMessageContent | minimum length 1; maximum length 16384 | — |
expected_source_attempt_generation | yes | integer | minimum 1.0 | — |
expected_source_attempt_version | yes | integer | minimum 1.0 | — |
target_attempt_id | no | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
target_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
SetVariableDefinitionCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | SetVariableDefinitionPayload | unknown fields forbidden | — |
SetVariableDefinitionPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
description | yes | string | minimum length 1; maximum length 2000 | — |
expected_version | no | integer | null | integer: minimum 1.0 | — |
name | yes | string | pattern ^[a-z][a-z0-9_.-]{0,127}$ | — |
producer_requirements | no | object | — | — |
sensitivity | no | VariableSensitivity | values public, internal, sensitive, restricted; default "internal" | — |
value_schema | yes | object | — | — |
value_type | yes | VariableValueType | values boolean, integer, number, string, json, table, artifact | — |
SettingsCatalog
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_storage_mode | yes | filesystem | r2 | values filesystem, r2 | — |
attempt_capability_signer_configured | yes | boolean | — | — |
auth_mode | yes | development | supabase | values development, supabase | — |
connectors | yes | array of ConnectorActivation | — | — |
inference_profiles | yes | array of InferenceProfileSummary | — | — |
provider_checks | yes | array of OperationalCheck | — | — |
schema_version | no | 1 | fixed value 1; default 1 | — |
web_research_profiles | yes | array of WebResearchProfileSummary | — | — |
Sha256Digest
Type: string
Constraints: pattern ^sha256:[0-9a-f]{64}$
SkillName
Type: string
Constraints: minimum length 1; maximum length 64; pattern ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])?$
SkillResourceSummary
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
kind | yes | reference | asset | values reference, asset | — |
media_type | yes | string | minimum length 1; maximum length 128 | — |
path | yes | string | minimum length 1; maximum length 512 | — |
size_bytes | yes | integer | minimum 0.0; maximum 2097152.0 | — |
SourceRevision
Type: string
Constraints: pattern ^(?:git:[0-9a-f]{40}|sha256:[0-9a-f]{64})$
SteerAttemptCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | SteerAttemptPayload | unknown fields forbidden | — |
SteerAttemptPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_attempt_generation | yes | integer | minimum 1.0 | — |
expected_attempt_version | yes | integer | minimum 1.0 | — |
instruction | yes | SteeringInstruction | minimum length 1; maximum length 16384 | — |
SteeringInstruction
Type: string Constraints: minimum length 1; maximum length 16384
StoryArtifact
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
content_url | yes | string | — | — |
manifest | yes | ArtifactManifest | unknown fields forbidden | — |
StoryAttempt
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
state | yes | succeeded | fixed value succeeded | — |
summary | yes | string | — | — |
StoryBlock
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_id | yes | BlockId | pattern ^blk_[0-9a-f]{32}$ | — |
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
execution_id | yes | ExecutionId | pattern ^exe_[0-9a-f]{32}$ | — |
execution_output_id | yes | ExecutionOutputId | pattern ^out_[0-9a-f]{32}$ | — |
output_text | yes | string | — | — |
source | yes | string | — | — |
StoryClaim
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
claim_id | yes | ClaimId | pattern ^clm_[0-9a-f]{32}$ | — |
claim_revision_id | yes | ClaimRevisionId | pattern ^crv_[0-9a-f]{32}$ | — |
currentness | yes | current | outdated | unknown | values current, outdated, unknown | — |
evidence_ref_id | yes | EvidenceRefId | pattern ^evr_[0-9a-f]{32}$ | — |
evidence_url | yes | string | — | — |
review_status | yes | draft | under_review | accepted | rejected | challenged | retracted | values draft, under_review, accepted, rejected, challenged, retracted | — |
text | yes | string | — | — |
validity | yes | untested | valid-for-pinned-inputs | invalidated | retracted | values untested, valid-for-pinned-inputs, invalidated, retracted | — |
StoryTask
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
objective | yes | string | — | — |
phase | yes | completed | fixed value completed | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
title | yes | string | — | — |
StoryWriteup
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
block_revision_id | yes | BlockRevisionId | pattern ^rev_[0-9a-f]{32}$ | — |
document_id | yes | DocumentId | pattern ^doc_[0-9a-f]{32}$ | — |
markdown | yes | string | — | — |
TabularArtifactPage
One explicit, bounded display page from an immutable Parquet artifact.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
cells_truncated | yes | boolean | — | — |
columns | yes | array of string | minimum items 1; maximum items 512 | — |
digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
next_offset | no | integer | null | integer: minimum 0.0; maximum 1000000000.0 | — |
offset | yes | integer | minimum 0.0; maximum 1000000000.0 | — |
page_byte_limited | yes | boolean | — | — |
requested_limit | yes | integer | minimum 1.0; maximum 1024.0 | — |
rows | yes | array of array of TabularCell | maximum items 1024 | — |
sample_null_counts | yes | array of integer | minimum items 1; maximum items 512 | — |
schema_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
total_rows | yes | integer | minimum 0.0; maximum 1000000000.0 | — |
TabularArtifactSchema
Bounded schema and shape proven from one immutable Parquet artifact.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
fields | yes | array of TabularFieldProjection | minimum items 1; maximum items 512 | — |
media_type | yes | application/vnd.apache.parquet | fixed value application/vnd.apache.parquet | — |
row_count | yes | integer | minimum 0.0; maximum 1000000000.0 | — |
row_group_count | yes | integer | minimum 0.0; maximum 122071.0 | — |
schema_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
size_bytes | yes | integer | minimum 12.0; maximum 10737418240.0 | — |
TabularCell
One JSON-safe display value; exact type remains in the verified schema.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
byte_size | yes | integer | minimum 0.0; maximum 10737418240.0 | — |
display | yes | string | maximum length 512 | — |
kind | yes | TabularCellKind | values null, boolean, integer, number, string, binary, date, time, datetime, duration, decimal | — |
truncated | no | boolean | default false | — |
TabularCellKind
Type: null | boolean | integer | number | string | binary | date | time | datetime | duration | decimal
Constraints: values null, boolean, integer, number, string, binary, date, time, datetime, duration, decimal
TabularFieldProjection
One verified Arrow field exposed without provider metadata.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
arrow_type | yes | string | minimum length 1; maximum length 256 | — |
name | yes | string | minimum length 1; maximum length 256 | — |
nullable | yes | boolean | — | — |
TaskAssignmentPolicy
Type: automatic | operator
Constraints: values automatic, operator
TaskConcurrencyClass
Type: parallel | exclusive
Constraints: values parallel, exclusive
TaskControlItem
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
active_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
assignment_policy | yes | TaskAssignmentPolicy | values automatic, operator | — |
concurrency_class | yes | TaskConcurrencyClass | values parallel, exclusive | — |
desired_state | yes | string | — | — |
estimated_cost_micros | yes | integer | minimum 0.0 | — |
execution_profile | yes | TaskExecutionProfile | values planning, research, verification | — |
hard_budget_micros | yes | integer | minimum 0.0 | — |
outcome | yes | string | null | — | — |
phase | yes | string | — | — |
priority | yes | integer | — | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
title | yes | string | — | — |
version | yes | integer | minimum 1.0 | — |
wait_reason | yes | string | — | — |
TaskControlSnapshot
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
plan_revision | yes | integer | minimum 1.0 | — |
run_budget_limit_micros | yes | integer | minimum 0.0 | — |
run_budget_reserved_micros | yes | integer | minimum 0.0 | — |
run_budget_spent_micros | yes | integer | minimum 0.0 | — |
run_generation | yes | integer | minimum 1.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
run_version | yes | integer | minimum 1.0 | — |
tasks | yes | array of TaskControlItem | maximum items 256 | — |
TaskDetailProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
task | yes | TaskProjection | unknown fields forbidden | — |
TaskEdgeProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
handoff | yes | object | — | — |
handoff_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
predecessor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
reason | yes | string | — | — |
successor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
TaskExecutionProfile
Type: planning | research | verification
Constraints: values planning, research, verification
TaskGraphEdgeProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
handoff | yes | DependencyHandoff | unknown fields forbidden | — |
handoff_digest | yes | string | pattern ^sha256:[0-9a-f]{64}$ | — |
predecessor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
reason | yes | string | — | — |
successor_task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
TaskGraphNodeProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
active_attempt_id | yes | AttemptId | null | AttemptId: pattern ^att_[0-9a-f]{32}$ | — |
allowed_tool_ids | yes | array of string | maximum items 32 | Compatibility metadata only; the server owns attempt tools. |
assignment_policy | yes | TaskAssignmentPolicy | values automatic, operator | — |
attempt_count | yes | integer | minimum 0.0 | — |
concurrency_class | yes | TaskConcurrencyClass | values parallel, exclusive | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
estimated_cost_micros | yes | integer | minimum 0.0 | — |
execution_profile | yes | TaskExecutionProfile | values planning, research, verification | — |
hard_budget_micros | yes | integer | minimum 0.0 | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
priority | yes | integer | minimum -1000.0; maximum 1000.0 | — |
required_environment_capabilities | yes | array of string | maximum items 8 | Compatibility metadata only; the server owns attempt environments. |
revision_action | yes | TaskRevisionAction | values new, retained, replanned | — |
source_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
starter_context | yes | string | maximum length 16384 | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
title | yes | string | — | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
TaskGraphPage
Node-keyset page plus every outgoing edge owned by those page nodes.
An edge appears on exactly the page containing its predecessor. Its successor may be outside the current node page, allowing a client to assemble the graph incrementally without duplicating edges across pages.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
edges | yes | array of TaskGraphEdgeProjection | maximum items 800 | — |
items | yes | array of TaskGraphNodeProjection | maximum items 25 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
plan_revision | yes | integer | minimum 1.0 | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
TaskId
Type: string
Constraints: pattern ^tsk_[0-9a-f]{32}$
TaskKey
Type: string
Constraints: pattern ^[a-z][a-z0-9_.-]{0,63}$
TaskObjective
Type: string Constraints: minimum length 1; maximum length 4000
TaskPage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of TaskProjection | — | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
TaskProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
acceptance_criteria | yes | array of string | — | — |
allowed_tool_ids | yes | array of string | maximum items 32 | Compatibility metadata only; the server owns attempt tools. |
assignment_policy | yes | automatic | operator | values automatic, operator | — |
concurrency_class | yes | parallel | exclusive | values parallel, exclusive | — |
created_at | yes | string | format date-time | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
estimated_cost_micros | yes | integer | minimum 0.0 | — |
execution_profile | yes | planning | research | verification | values planning, research, verification | — |
generation | yes | integer | minimum 1.0 | — |
hard_budget_micros | yes | integer | minimum 0.0 | — |
objective | yes | string | — | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
plan_revision | yes | integer | minimum 1.0 | — |
plan_version_id | yes | PlanVersionId | pattern ^pln_[0-9a-f]{32}$ | — |
priority | yes | integer | minimum -1000.0; maximum 1000.0 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
required_environment_capabilities | yes | array of string | maximum items 8 | Compatibility metadata only; the server owns attempt environments. |
revision_action | yes | new | retained | replanned | values new, retained, replanned | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
source_task_id | yes | TaskId | null | TaskId: pattern ^tsk_[0-9a-f]{32}$ | — |
starter_context | yes | string | maximum length 16384 | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
title | yes | string | — | — |
version | yes | integer | minimum 1.0 | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
TaskProposedEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | task.proposed | fixed value task.proposed | — |
objective | yes | string | — | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
title | yes | string | — | — |
TaskRevisionAction
Type: new | retained | replanned
Constraints: values new, retained, replanned
TaskSearchLocator
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
kind | yes | task | fixed value task | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
TaskStateGroup
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
count | yes | integer | minimum 1.0 | — |
desired_state | yes | DesiredState | values running, paused, cancelled | — |
outcome | yes | WorkOutcome | null | WorkOutcome: values succeeded, failed, cancelled | — |
phase | yes | WorkPhase | values queued, provisioning, executing, finalizing, terminal | — |
revision_action | yes | TaskRevisionAction | values new, retained, replanned | — |
wait_reason | yes | WaitReason | values none, approval, dependency, capacity, input, budget, operator | — |
TaskSummaryProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
active_attempt_count | yes | integer | minimum 0.0 | — |
attempt_count | yes | integer | minimum 0.0 | — |
attempt_groups | yes | array of AttemptStateGroup | maximum items 1024 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
plan_revision | yes | integer | minimum 1.0 | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
task_count | yes | integer | minimum 0.0 | — |
task_groups | yes | array of TaskStateGroup | maximum items 512 | — |
TaskTitle
Type: string Constraints: minimum length 1; maximum length 240
TaskToolId
Type: string
Constraints: pattern ^[a-z][a-z0-9_.:-]{0,127}$
ToolApproval
Canonical projection of one attempt-generation approval.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
approval_id | yes | InteractionRequestId | pattern ^int_[0-9a-f]{32}$ | — |
argument_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
attempt_generation | yes | integer | minimum 1.0 | — |
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
expires_at | yes | string | format date-time | — |
permitted_decisions | yes | array of object | minimum items 2; maximum items 2 | — |
policy_version | yes | integer | minimum 1.0 | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
request | yes | ToolApprovalRequest | unknown fields forbidden | — |
request_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
resolution | yes | ApprovalResolution | null | ApprovalResolution: unknown fields forbidden | — |
resolved_at | yes | string | null | string: format date-time | — |
run_id | yes | RunId | pattern ^run_[0-9a-f]{32}$ | — |
state | yes | pending | approved | denied | expired | cancelled | values pending, approved, denied, expired, cancelled | — |
task_id | yes | TaskId | pattern ^tsk_[0-9a-f]{32}$ | — |
version | yes | integer | minimum 1.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
ToolApprovalActor
The trusted product identity requesting one tool action.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
kind | no | attempt | fixed value attempt; default "attempt" | — |
label | yes | ApprovalActorLabel | minimum length 1; maximum length 120 | — |
ToolApprovalBudgetImpact
Canonical cost and headroom snapshot captured with the request.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
estimated_cost_micros | yes | integer | minimum 0.0; maximum 10000000000.0 | — |
estimated_duration_seconds | no | integer | null | integer: minimum 0.0; maximum 86400.0 | — |
remaining_cost_micros | yes | integer | minimum 0.0 | — |
scope | yes | BudgetScope | values workspace, project, run, task, attempt | — |
ToolApprovalPage
A bounded page within one exact attempt lineage.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
items | yes | array of ToolApproval | maximum items 100 | — |
latest_cursor | yes | Cursor | pattern ^c2_[A-Za-z0-9_-]{32}$ | — |
next_after | no | InteractionRequestId | null | InteractionRequestId: pattern ^int_[0-9a-f]{32}$ | — |
ToolApprovalRequest
The exact normalized tool request a person is being asked to allow.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
action | yes | ApprovalAction | minimum length 1; maximum length 240 | — |
actor | yes | ToolApprovalActor | unknown fields forbidden | — |
arguments | yes | object | — | — |
budget | yes | ToolApprovalBudgetImpact | unknown fields forbidden | — |
data_exposure | yes | ToolDataExposure | unknown fields forbidden | — |
risk_class | yes | ToolRiskClass | values read, write, execute, external_side_effect, credentialed, destructive | — |
summary | yes | ApprovalSummary | minimum length 1; maximum length 500 | — |
target | yes | ApprovalTarget | minimum length 1; maximum length 500 | — |
tool_call_id | yes | ToolCallIdentifier | minimum length 1; maximum length 128 | — |
tool_id | yes | PolicyIdentifier | pattern ^[a-z][a-z0-9_.:-]{0,127}$ | — |
ToolCallIdentifier
Type: string Constraints: minimum length 1; maximum length 128
ToolDataExposure
Trusted description of the data boundary crossed by one tool.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
classification | yes | DataClassification | values public, internal, confidential, restricted | — |
egress | yes | boolean | — | — |
label | yes | string | minimum length 1; maximum length 240 | — |
ToolEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
detail | no | string | null | — | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | tool.requested | tool.started | tool.delta | tool.completed | values tool.requested, tool.started, tool.delta, tool.completed | — |
occurred_at | yes | string | format date-time | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
status | yes | requested | running | succeeded | failed | values requested, running, succeeded, failed | — |
tool_call_id | yes | string | — | — |
tool_name | yes | string | — | — |
ToolRiskClass
Type: read | write | execute | external_side_effect | credentialed | destructive
Constraints: values read, write, execute, external_side_effect, credentialed, destructive
UnsupportedDisposition
Type: quarantined
Constraints: fixed value quarantined
UnsupportedExtensionSurface
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
disposition | no | UnsupportedDisposition | fixed value quarantined; default "quarantined" | — |
path | no | string | null | string: minimum length 1; maximum length 512 | — |
reason | yes | string | minimum length 1; maximum length 1000 | — |
surface | yes | string | pattern ^[a-z][a-z0-9_.:-]{1,127}$ | — |
UpdateDraftTaskCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | UpdateDraftTaskPayload | unknown fields forbidden | — |
UpdateDraftTaskPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
acceptance_criteria | no | array of AcceptanceCriterion | null | array of AcceptanceCriterion: minimum items 1; maximum items 20 | — |
allowed_tool_ids | no | array of TaskToolId | null | array of TaskToolId: minimum items 1; maximum items 32 | Compatibility metadata only; the server owns attempt tools. |
assignment_policy | no | TaskAssignmentPolicy | null | TaskAssignmentPolicy: values automatic, operator | — |
concurrency_class | no | TaskConcurrencyClass | null | TaskConcurrencyClass: values parallel, exclusive | — |
estimated_cost_micros | no | integer | null | integer: minimum 0.0; maximum 10000000000.0 | — |
execution_profile | no | TaskExecutionProfile | null | TaskExecutionProfile: values planning, research, verification | — |
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
hard_budget_micros | no | integer | null | integer: minimum 0.0; maximum 10000000000.0 | — |
objective | no | TaskObjective | null | TaskObjective: minimum length 1; maximum length 4000 | — |
priority | no | integer | null | integer: minimum -1000.0; maximum 1000.0 | — |
required_environment_capabilities | no | array of EnvironmentCapability | null | array of EnvironmentCapability: minimum items 1; maximum items 8 | Compatibility metadata only; the server owns attempt environments. |
starter_context | no | string | null | string: maximum length 16384 | — |
title | no | TaskTitle | null | TaskTitle: minimum length 1; maximum length 240 | — |
UpdateProjectSettingsCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | UpdateProjectSettingsPayload | unknown fields forbidden | — |
UpdateProjectSettingsPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_version | yes | integer | minimum 1.0 | — |
settings | yes | ProjectSettings | unknown fields forbidden | — |
UpdateScheduleCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | UpdateSchedulePayload | unknown fields forbidden | — |
UpdateSchedulePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_version | yes | integer | minimum 1.0 | — |
template | yes | ScheduleRunTemplate | unknown fields forbidden | — |
timing | yes | ScheduleTiming | unknown fields forbidden | — |
UpdateTaskBudgetCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | UpdateTaskBudgetPayload | unknown fields forbidden | — |
UpdateTaskBudgetPayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
hard_budget_micros | yes | integer | minimum 0.0; maximum 10000000000.0 | — |
UpdateTaskExecutionProfileCommand
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
command_id | yes | CommandId | pattern ^cmd_[0-9a-f]{32}$ | — |
idempotency_key | yes | string | minimum length 8; maximum length 128 | — |
payload | yes | UpdateTaskExecutionProfilePayload | unknown fields forbidden | — |
UpdateTaskExecutionProfilePayload
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
execution_profile | yes | TaskExecutionProfile | values planning, research, verification | — |
expected_plan_revision | yes | integer | minimum 1.0 | — |
expected_run_generation | yes | integer | minimum 1.0 | — |
expected_run_version | yes | integer | minimum 1.0 | — |
expected_task_version | yes | integer | minimum 1.0 | — |
UsageUpdatedEvent
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
estimated_cost_micros | yes | integer | minimum 0.0 | — |
event_id | yes | EventId | pattern ^eve_[0-9a-f]{32}$ | — |
event_type | yes | usage.updated | fixed value usage.updated | — |
input_tokens | yes | integer | minimum 0.0 | — |
occurred_at | yes | string | format date-time | — |
output_tokens | yes | integer | minimum 0.0 | — |
provider_sequence | yes | integer | minimum 0.0 | — |
replayable | no | boolean | default true | — |
ValidationMethod
Type: rerun | fresh_sandbox_replication | independent_implementation | leakage_check | perturbation | statistical_check | data_quality_check | contradiction_search | raw_metric_check
Constraints: values rerun, fresh_sandbox_replication, independent_implementation, leakage_check, perturbation, statistical_check, data_quality_check, contradiction_search, raw_metric_check
ValidationOutcome
Type: passed | failed | inconclusive | error
Constraints: values passed, failed, inconclusive, error
ValidationSummary
Type: string Constraints: minimum length 1; maximum length 8000
VariableDefinitionId
Type: string
Constraints: pattern ^vdf_[0-9a-f]{32}$
VariableDefinitionProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
created_at | yes | string | format date-time | — |
description | yes | string | — | — |
live_anchor_id | yes | LiveAnchorId | pattern ^anc_[0-9a-f]{32}$ | — |
name | yes | string | — | — |
producer_requirements | yes | object | — | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
sensitivity | yes | VariableSensitivity | values public, internal, sensitive, restricted | — |
value_schema | yes | object | — | — |
value_type | yes | VariableValueType | values boolean, integer, number, string, json, table, artifact | — |
variable_definition_id | yes | VariableDefinitionId | pattern ^vdf_[0-9a-f]{32}$ | — |
version | yes | integer | minimum 1.0 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
VariablePage
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
current_values | yes | array of VariableValueProjection | — | — |
definitions | yes | array of VariableDefinitionProjection | — | — |
VariableSensitivity
Type: public | internal | sensitive | restricted
Constraints: values public, internal, sensitive, restricted
VariableValueEvidenceTarget
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
target_kind | yes | variable_value | fixed value variable_value | — |
variable_value_id | yes | VariableValueId | pattern ^val_[0-9a-f]{32}$ | — |
VariableValueId
Type: string
Constraints: pattern ^val_[0-9a-f]{32}$
VariableValueOrigin
Type: captured | manual | imported
Constraints: values captured, manual, imported
VariableValueProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
author | yes | KnowledgeActor | unknown fields forbidden | — |
block_revision_id | yes | BlockRevisionId | null | BlockRevisionId: pattern ^rev_[0-9a-f]{32}$ | — |
content_hash | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
created_at | yes | string | format date-time | — |
environment_digest | yes | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
inline | yes | InlineVariableValue | null | InlineVariableValue: unknown fields forbidden | — |
input_manifest | yes | object | — | — |
origin | yes | VariableValueOrigin | values captured, manual, imported | — |
producing_execution_id | yes | ExecutionId | null | ExecutionId: pattern ^exe_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
retracted_at | yes | string | null | string: format date-time | — |
retraction_reason | yes | string | null | — | — |
revision | yes | integer | minimum 1.0 | — |
source_import_id | yes | ProjectImportId | null | ProjectImportId: pattern ^imp_[0-9a-f]{32}$ | — |
state | yes | VariableValueState | values active, retracted | — |
value_manifest | yes | object | — | — |
variable_definition_id | yes | VariableDefinitionId | pattern ^vdf_[0-9a-f]{32}$ | — |
variable_value_id | yes | VariableValueId | pattern ^val_[0-9a-f]{32}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
VariableValueState
Type: active | retracted
Constraints: values active, retracted
VariableValueType
Type: boolean | integer | number | string | json | table | artifact
Constraints: values boolean, integer, number, string, json, table, artifact
WaitReason
Type: none | approval | dependency | capacity | input | budget | operator
Constraints: values none, approval, dependency, capacity, input, budget, operator
WebResearchProfileSummary
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
fetch_reservation_micros | yes | integer | minimum 0.0 | — |
native_mode | yes | turbo | instant | values turbo, instant | — |
profile_id | yes | string | minimum length 3; maximum length 64 | — |
provider | yes | parallel | exa | values parallel, exa | — |
search_reservation_micros | yes | integer | minimum 0.0 | — |
supported_languages | yes | array of string | null | — | — |
supports_published_before | yes | boolean | — | — |
WorkOutcome
Type: succeeded | failed | cancelled
Constraints: values succeeded, failed, cancelled
WorkPhase
Type: queued | provisioning | executing | finalizing | terminal
Constraints: values queued, provisioning, executing, finalizing, terminal
WorkspaceChangeKind
Type: added | modified | deleted
Constraints: values added, modified, deleted
WorkspaceChangeSetManifest
Reviewable patch metadata against one pinned project snapshot.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
base_snapshot_artifact_id | no | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
base_snapshot_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
base_workspace_version | yes | integer | minimum 0.0 | — |
candidate_snapshot_artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
candidate_snapshot_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
candidate_workspace_version | yes | integer | minimum 1.0 | — |
changes | yes | array of WorkspacePathChange | minimum items 1; maximum items 256 | — |
git_status | yes | WorkspaceGitStatus | unknown fields forbidden | — |
producing_attempt_generation | yes | integer | minimum 1.0 | — |
producing_attempt_id | yes | AttemptId | pattern ^att_[0-9a-f]{32}$ | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
version | no | 1 | fixed value 1; default 1 | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
WorkspaceFileReference
One accepted path pointing at separately verified content bytes.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
artifact_id | yes | ArtifactId | pattern ^art_[0-9a-f]{32}$ | — |
digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
executable | no | boolean | default false | — |
media_type | yes | string | minimum length 3; maximum length 255 | — |
path | yes | string | minimum length 1; maximum length 512 | — |
size_bytes | yes | integer | minimum 0.0; maximum 8388608.0 | — |
WorkspaceGitStatus
Bounded Git interoperability metadata; never product state.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
branch | no | string | null | string: minimum length 1; maximum length 255 | — |
detached | no | boolean | default false | — |
head_commit | no | string | null | string: pattern ^[0-9a-f]{40}(?:[0-9a-f]{24})?$ | — |
porcelain_v2 | no | string | maximum length 65536; default "" | — |
WorkspaceId
Type: string
Constraints: pattern ^wsp_[0-9a-f]{32}$
WorkspaceManifest
The complete accepted content-addressed project checkout.
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
files | yes | array of WorkspaceFileReference | maximum items 256 | — |
version | no | 1 | fixed value 1; default 1 | — |
WorkspaceName
Type: string Constraints: minimum length 1; maximum length 200
WorkspacePathChange
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
after_artifact_id | no | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
after_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
before_digest | no | Sha256Digest | null | Sha256Digest: pattern ^sha256:[0-9a-f]{64}$ | — |
kind | yes | WorkspaceChangeKind | values added, modified, deleted | — |
path | yes | string | minimum length 1; maximum length 512 | — |
safe_text_patch | no | string | null | string: maximum length 131072 | — |
WorkspaceSnapshotProjection
| Field | Required | Type | Constraints/default | Description |
|---|---|---|---|---|
manifest | yes | WorkspaceManifest | unknown fields forbidden | — |
project_id | yes | ProjectId | pattern ^prj_[0-9a-f]{32}$ | — |
workspace_artifact_id | yes | ArtifactId | null | ArtifactId: pattern ^art_[0-9a-f]{32}$ | — |
workspace_digest | yes | Sha256Digest | pattern ^sha256:[0-9a-f]{64}$ | — |
workspace_id | yes | WorkspaceId | pattern ^wsp_[0-9a-f]{32}$ | — |
workspace_version | yes | integer | minimum 0.0 | — |