Skip to main content
POST
Commit annotations

Authorizations

Authorization
string
header
required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Body

application/json

At most 256 changes across upserts, deletes, answerUpserts and answerDeletes; an events-only batch (checkpoint: false) carries at least one change; an annotation id appears at most once in upserts and never in both upserts and deletes; a batch that writes a commit and names no taskId carries a message.

branchId
string
required
Required string length: 1 - 200
deletes
string[]
required
Required string length: 1 - 200
idempotencyKey
string
required
Required string length: 1 - 200
message
string
required
Required string length: 1 - 500
projectId
string
required
Required string length: 1 - 200
upserts
object[]
required
answerDeletes
object[]
answerUpserts
object[]
checkpoint
boolean
taxonomyVersion
string | null
Pattern: ^sha256:([0-9a-f]{64})$

Response

Commit annotations

commit
object
required
kind
string
required
Allowed value: "committed"