Syndai Docs

Get a run's change state

GET
/api/v1/external/coding/runs/{coding_run_id}/change

ChangeState: state, a server-written headline, the questions it waits on (needs_input), a hold and its review_url, live_url, done and the CLI's exit_code. Pass the last cursor with wait (seconds, at most 45) to block until something that matters changes; without a cursor it answers at once. It may return early, unchanged, when the server restarts: call again.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

coding_run_id*string
Formatuuid

Query Parameters

wait?integer
Range0 <= value <= 45
Default0
cursor?|null
customer_id?|null

Response Body

Request fulfilled, document follows

application/json
  1. response
cursor*string
done*boolean
exit_code?integer|null
headline*string
held?|null
live_url?string|null
needs_input*array<>
pr_url?string|null
project*
queue_position?integer|null
receipt_url?string|null
run_id*string
Formatuuid
run_url*string
state*string
verified?boolean|null
Example Request
curl -X GET 'https://api.syndai.ai/api/v1/external/coding/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/change'
Example Response
{  "cursor": "string",  "done": true,  "exit_code": 0,  "headline": "string",  "held": {    "can_retry": true,    "head_sha": "string",    "message": "string",    "paths": [      "string"    ],    "reason": "string",    "review_url": "string"  },  "live_url": "string",  "needs_input": [    {      "hitl_request_id": "1aa3fc62-1cee-4e90-a673-f84ebe5ed881",      "inputs": [        {          "context": "string",          "default_assumption": "string",          "default_option_ids": [            "string"          ],          "free_text": {            "enabled": true,            "max_length": 0,            "placeholder": "string",            "required_policy": "string",            "ui_mode": "string"          },          "input_id": "string",          "kind": "string",          "options": [            {              "id": "string",              "label": "string"            }          ],          "prompt": "string",          "required": true        }      ],      "kind": "string",      "summary": "string"    }  ],  "pr_url": "string",  "project": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "live_url": "string",    "name": "string"  },  "queue_position": 0,  "receipt_url": "string",  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",  "run_url": "string",  "state": "string",  "verified": true}