Overview
Endpoints
- POSTAnnotate a run
- POSTSave a checkpoint
- POSTMark run as complete
- POSTContinue execution
- POSTMark run as failed
- POSTSend a heartbeat
- POSTRecord an iteration
- POSTSend a log entry
- GETList memory entries
- GETGet a memory value
- POSTSet a memory value
- DELDelete a memory value
- POSTRecord an output
- GETGet run payload
- POSTReport execution progress
- POSTSave a resource snapshot
- POSTReport resource utilization
- POSTSpawn a child run
- GETList run state
- POSTSet run state
- GETGet a state value
- DELDelete a state value
- POSTSend a stream chunk
- POSTRecord a tool call
- POSTReport resource usage
- POSTWait for an external event
SDK
Report execution progress
Reports execution progress as a percentage for monitoring.
POST
/
sdk
/
v1
/
runs
/
{runID}
/
progress
Report execution progress
curl --request POST \
--url https://api.strait.dev/sdk/v1/runs/{runID}/progress \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"percent": 123,
"eta_seconds": 123,
"step": "<string>"
}
'{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"message": "<string>",
"run_id": "<string>",
"type": "<string>",
"$schema": "<string>",
"data": "<unknown>",
"level": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.strait.dev/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key passed as Bearer token
Path Parameters
Body
application/json
⌘I
Report execution progress
curl --request POST \
--url https://api.strait.dev/sdk/v1/runs/{runID}/progress \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"percent": 123,
"eta_seconds": 123,
"step": "<string>"
}
'{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"message": "<string>",
"run_id": "<string>",
"type": "<string>",
"$schema": "<string>",
"data": "<unknown>",
"level": "<string>"
}