Skip to content

Landing changes

Submit changes and follow their checks and landing results.

OperationRequest
Landing statusGET /v1/land
Submit landingPOST /v1/land
Show landingGET /v1/land/{id}
Withdraw landingDELETE /v1/land/{id}

Landing status

GET /v1/land · landingStatus

Uses the configured repository's CLI landing queue. Requires an account allowed to run agent work. Reuse the request ID and exact inputs on retry. Only the submitter or an administrator may withdraw a queued change.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Response

200 — Landing queue result.

Type: LandStatus

FieldTypeRequiredDescription
queuestringNo

Default: "".

integratorobjectYes

Whether the integrator has sent a recent heartbeat, and its latest report.

integrator.runningbooleanYes
integrator.heartbeatobject or nullNo

The integrator's latest report of its work and capacity.

integrator.heartbeat.machinestringYes
integrator.heartbeat.atinteger (uint64)Yes
integrator.heartbeat.currentstring or nullNo
integrator.heartbeat.instanceobject or nullNo

The cloud computer that runs the integrator.

integrator.heartbeat.instance.projectstringYes
integrator.heartbeat.instance.zonestringYes
integrator.heartbeat.instance.namestringYes
integrator.heartbeat.slotsarray of objectNo
integrator.heartbeat.slots[].slotstringYes
integrator.heartbeat.slots[].lanestringYes
integrator.heartbeat.slots[].entrystringYes
integrator.heartbeat.slots[].sinceinteger (uint64)Yes
integrator.heartbeat.capacityinteger (uint32) or nullNo
integrator.heartbeat.drainingbooleanNo

Default: false.

waitingarray of objectNo

Default: [].

waiting[].idstringYes
waiting[].branchstringYes
waiting[].targetstringYes
waiting[].issueinteger (uint64) or nullNo
waiting[].closebooleanNo

Default: false.

waiting[].authorstringYes
waiting[].machinestringYes
waiting[].summarystringYes
waiting[].headstringYes
waiting[].submitted_atinteger (uint64)Yes
waiting[].stateone of "queued", "landing", "landed", "bounced", "withdrawn"Yes

Where a submitted change stands.

waiting[].updated_atinteger (uint64)Yes
waiting[].triesinteger (uint32)No

Default: 0.

waiting[].commitstring or nullNo
waiting[].reasonstring or nullNo
waiting[].workerstring or nullNo
waiting[].laneone of "fast", "code", nullNo

Which checks the integrator runs for a change.

waiting[].slotstring or nullNo
waiting[].started_atinteger (uint64) or nullNo
waiting[].waiting_forstring or nullNo
waiting[].recordsarray of objectNo
waiting[].records[].entrystringYes
waiting[].records[].numberinteger (uint32)Yes
waiting[].records[].workerstringYes
waiting[].records[].started_atinteger (uint64)Yes
waiting[].records[].ended_atinteger (uint64)Yes
waiting[].records[].outcomestringYes
waiting[].records[].target_beforestringYes
waiting[].records[].commitstring or nullNo
waiting[].records[].landingarray of stringNo

Default: [].

waiting[].records[].checksarray of stringNo

Default: [].

waiting[].records[].problemsarray of stringNo

Default: [].

waiting[].records[].repairedbooleanNo

Default: false.

waiting[].records[].notesarray of stringNo

Default: [].

waiting[].records[].lanestringNo
waiting[].records[].slotstringNo
waiting[].records[].regeneratedarray of stringNo
landingarray of objectNo

Default: [].

landing[].idstringYes
landing[].branchstringYes
landing[].targetstringYes
landing[].issueinteger (uint64) or nullNo
landing[].closebooleanNo

Default: false.

landing[].authorstringYes
landing[].machinestringYes
landing[].summarystringYes
landing[].headstringYes
landing[].submitted_atinteger (uint64)Yes
landing[].stateone of "queued", "landing", "landed", "bounced", "withdrawn"Yes

Where a submitted change stands.

landing[].updated_atinteger (uint64)Yes
landing[].triesinteger (uint32)No

Default: 0.

landing[].commitstring or nullNo
landing[].reasonstring or nullNo
landing[].workerstring or nullNo
landing[].laneone of "fast", "code", nullNo

Which checks the integrator runs for a change.

landing[].slotstring or nullNo
landing[].started_atinteger (uint64) or nullNo
landing[].waiting_forstring or nullNo
landing[].recordsarray of objectNo
landing[].records[].entrystringYes
landing[].records[].numberinteger (uint32)Yes
landing[].records[].workerstringYes
landing[].records[].started_atinteger (uint64)Yes
landing[].records[].ended_atinteger (uint64)Yes
landing[].records[].outcomestringYes
landing[].records[].target_beforestringYes
landing[].records[].commitstring or nullNo
landing[].records[].landingarray of stringNo

Default: [].

landing[].records[].checksarray of stringNo

Default: [].

landing[].records[].problemsarray of stringNo

Default: [].

landing[].records[].repairedbooleanNo

Default: false.

landing[].records[].notesarray of stringNo

Default: [].

landing[].records[].lanestringNo
landing[].records[].slotstringNo
landing[].records[].regeneratedarray of stringNo
failedarray of objectNo

Default: [].

failed[].idstringYes
failed[].branchstringYes
failed[].targetstringYes
failed[].issueinteger (uint64) or nullNo
failed[].closebooleanNo

Default: false.

failed[].authorstringYes
failed[].machinestringYes
failed[].summarystringYes
failed[].headstringYes
failed[].submitted_atinteger (uint64)Yes
failed[].stateone of "queued", "landing", "landed", "bounced", "withdrawn"Yes

Where a submitted change stands.

failed[].updated_atinteger (uint64)Yes
failed[].triesinteger (uint32)No

Default: 0.

failed[].commitstring or nullNo
failed[].reasonstring or nullNo
failed[].workerstring or nullNo
failed[].laneone of "fast", "code", nullNo

Which checks the integrator runs for a change.

failed[].slotstring or nullNo
failed[].started_atinteger (uint64) or nullNo
failed[].waiting_forstring or nullNo
failed[].recordsarray of objectNo
failed[].records[].entrystringYes
failed[].records[].numberinteger (uint32)Yes
failed[].records[].workerstringYes
failed[].records[].started_atinteger (uint64)Yes

The first 120 fields are shown; the contract has the rest.

Errors

StatusMeaningBody
400, 401, 403, 404, 409, 413, 503

Invalid request, signed out, denied, missing, conflict, too large, or unavailable.

AppAccountError

Example

curl 'https://api.openagents.com/v1/land' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

Submit landing

POST /v1/land · submitLanding

Uses the configured repository's CLI landing queue. Requires an account allowed to run agent work. Reuse the request ID and exact inputs on retry. Only the submitter or an administrator may withdraw a queued change.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

NameInTypeRequiredDescription
Idempotency-KeyheaderstringYes

Request body

Content type: application/json

Type: LandSubmit

FieldTypeRequiredDescription
repostringYes
branchstringYes
issueinteger (uint64) or nullNo
summarystring or nullNo

Response

201 — Landing queue result.

Type: LandEntry

FieldTypeRequiredDescription
idstringYes
branchstringYes
targetstringYes
issueinteger (uint64) or nullNo
closebooleanNo

Default: false.

authorstringYes
machinestringYes
summarystringYes
headstringYes
submitted_atinteger (uint64)Yes
stateone of "queued", "landing", "landed", "bounced", "withdrawn"Yes

Where a submitted change stands.

updated_atinteger (uint64)Yes
triesinteger (uint32)No

Default: 0.

commitstring or nullNo
reasonstring or nullNo
workerstring or nullNo
laneone of "fast", "code", nullNo

Which checks the integrator runs for a change.

slotstring or nullNo
started_atinteger (uint64) or nullNo
waiting_forstring or nullNo
recordsarray of objectNo
records[].entrystringYes
records[].numberinteger (uint32)Yes
records[].workerstringYes
records[].started_atinteger (uint64)Yes
records[].ended_atinteger (uint64)Yes
records[].outcomestringYes
records[].target_beforestringYes
records[].commitstring or nullNo
records[].landingarray of stringNo

Default: [].

records[].checksarray of stringNo

Default: [].

records[].problemsarray of stringNo

Default: [].

records[].repairedbooleanNo

Default: false.

records[].notesarray of stringNo

Default: [].

records[].lanestringNo
records[].slotstringNo
records[].regeneratedarray of stringNo

Errors

StatusMeaningBody
400, 401, 403, 404, 409, 413, 503

Invalid request, signed out, denied, missing, conflict, too large, or unavailable.

AppAccountError

Example

curl -X POST 'https://api.openagents.com/v1/land' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN" \
  -H 'Idempotency-Key: ...' \
  -H 'Content-Type: application/json' \
  -d '{
  "repo": "string",
  "branch": "string"
}'

Show landing

GET /v1/land/{id} · showLanding

Uses the configured repository's CLI landing queue. Requires an account allowed to run agent work. Reuse the request ID and exact inputs on retry. Only the submitter or an administrator may withdraw a queued change.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

NameInTypeRequiredDescription
idpathstringYes

Response

200 — Landing queue result.

Type: LandEntry

FieldTypeRequiredDescription
idstringYes
branchstringYes
targetstringYes
issueinteger (uint64) or nullNo
closebooleanNo

Default: false.

authorstringYes
machinestringYes
summarystringYes
headstringYes
submitted_atinteger (uint64)Yes
stateone of "queued", "landing", "landed", "bounced", "withdrawn"Yes

Where a submitted change stands.

updated_atinteger (uint64)Yes
triesinteger (uint32)No

Default: 0.

commitstring or nullNo
reasonstring or nullNo
workerstring or nullNo
laneone of "fast", "code", nullNo

Which checks the integrator runs for a change.

slotstring or nullNo
started_atinteger (uint64) or nullNo
waiting_forstring or nullNo
recordsarray of objectNo
records[].entrystringYes
records[].numberinteger (uint32)Yes
records[].workerstringYes
records[].started_atinteger (uint64)Yes
records[].ended_atinteger (uint64)Yes
records[].outcomestringYes
records[].target_beforestringYes
records[].commitstring or nullNo
records[].landingarray of stringNo

Default: [].

records[].checksarray of stringNo

Default: [].

records[].problemsarray of stringNo

Default: [].

records[].repairedbooleanNo

Default: false.

records[].notesarray of stringNo

Default: [].

records[].lanestringNo
records[].slotstringNo
records[].regeneratedarray of stringNo

Errors

StatusMeaningBody
400, 401, 403, 404, 409, 413, 503

Invalid request, signed out, denied, missing, conflict, too large, or unavailable.

AppAccountError

Example

curl 'https://api.openagents.com/v1/land/{id}' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"

Withdraw landing

DELETE /v1/land/{id} · withdrawLanding

Uses the configured repository's CLI landing queue. Requires an account allowed to run agent work. Reuse the request ID and exact inputs on retry. Only the submitter or an administrator may withdraw a queued change.

Sign-in: a bearer credential in the Authorization header.

appBearer: A live app sess_ session or oa_sk_ sign-in key. Account-bound oak_ keys are accepted only where the operation declares them and their scopes permit it. API cookies are ignored.

Parameters

NameInTypeRequiredDescription
idpathstringYes

Response

204 — Landing queue result.

Errors

StatusMeaningBody
400, 401, 403, 404, 409, 413, 503

Invalid request, signed out, denied, missing, conflict, too large, or unavailable.

AppAccountError

Example

curl -X DELETE 'https://api.openagents.com/v1/land/{id}' \
  -H "Authorization: Bearer $OPENAGENTS_TOKEN"