SparQDocs
GuidesAPI referencesparqhq.ai
API referenceRuns

Answer Question

POST
/v1/runs/{run_id}/resume

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Answer the run's question. Any server can continue the run.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

run_id*Run Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body

Body of POST /v1/runs/{run_id}/resume: the answer to a question.

question_id*Question Id
Formatuuid
choice?|null
text?|null

Response Body

Successful Response

application/json
  1. response
run_id*Run Id
Formatuuid
session_id*|null
parent_run_id*|null
project_id*Project Id
Formatuuid
release_id*Release Id
Formatuuid
agent*
status*RunStatus

Where a run is. The last eight values are terminal.

Value in"queued""running""awaiting_input""completed""cancelled""limit_hit""budget_exceeded""tool_unavailable""verify_failed""awaiting_input_expired""error"
question*|

Set while waiting for an answer.

approval*|

Set while waiting for an approval.

output*|

Typed result matching the agent's output schema, once completed.

error*|

Set when the run ended in a failure state.

usage*|null
credential_id*Credential Id
Formatuuid
created_at*Created At
Formatdate-time
ended_at*|null
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/runs/497f6eca-6276-4993-bfeb-53cbbbba6f08/resume' \  -H 'Content-Type: application/json' \  -d '{  "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25"}'
Example Response
{  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",  "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",  "parent_run_id": "f8faf8c1-9778-49a4-9004-628cdb0047e5",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "release_id": "51d53377-463c-43a4-a864-f9b3ed9178de",  "agent": {    "name": "string",    "version": "1.4.0"  },  "status": "queued",  "question": {    "question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",    "text": "string",    "options": [      "string"    ],    "allow_free_text": true,    "expires_at": "2019-08-24T14:15:22Z"  },  "approval": {    "approval_id": "15af2260-72db-4fc4-b587-6b841d6a3d55",    "tool": "tickets.get",    "effect": "read",    "summary": "string",    "arguments": {},    "editable": true,    "expires_at": "2019-08-24T14:15:22Z",    "invocation_id": "9efe53a2-0f4e-415e-a218-b405e1367798",    "arguments_hash": "string"  },  "output": null,  "error": {    "type": "about:blank",    "title": "string",    "status": 400,    "code": "no_compliant_model",    "detail": "string",    "instance": "string",    "request_id": "string",    "issues": [      {        "path": "string",        "message": "string"      }    ],    "geo_id": "string"  },  "usage": {    "input_tokens": 0,    "output_tokens": 0,    "cached_tokens": 0,    "reasoning_tokens": 0,    "estimated_cost_usd": "string",    "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242"  },  "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242",  "created_at": "2019-08-24T14:15:22Z",  "ended_at": "2019-08-24T14:15:22Z"}

Request Erasure POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Erase one end user's data in every store (SQR-07), with proof of deletion per store.

Cancel Run POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.