Skip to main content
GET
/
test_framework
/
v1
/
scenarios
/
scenario-agent-progress
cURL
curl --request GET \
  --url https://api.cekura.ai/test_framework/v1/scenarios/scenario-agent-progress/ \
  --header 'X-CEKURA-API-KEY: <api-key>'
{
  "progress_id": "<string>",
  "session_id": 123,
  "mode": "<string>",
  "status": "<string>",
  "result": {},
  "error": "<string>"
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Query Parameters

​
progress_id
string
required

The progress_id returned by POST /scenario-agent/

Response

Response serializer for GET /scenario-agent-progress/?progress_id=...

status lifecycle:

  • in_progress → LLM still running; poll again
  • completed → LLM finished; result holds the full response
  • needs_clarification → (clarify mode) LLM needs a follow-up answer from user
  • needs_agent_clarification → (improve mode) LLM needs user to select an agent
  • cancelled → user called /cancel-agent/
  • failed → unrecoverable error; error is set
​
progress_id
string
​
session_id
integer | null
​
mode
string

clarify or improve

​
status
string

in_progress | completed | needs_clarification | needs_agent_clarification | cancelled | failed

​
result
object

ScenarioAgentResponseSerializer payload; null while status is in_progress

​
error
string | null

Error message when status is failed