CEcekura
test_framework

Get scenario-refinement progress

Changed on

Check the progress of a scenario-instruction clarification request.

After calling POST /scenario-agent/, use the returned progress_id to poll this endpoint.

Status values:

  • in_progress - AI is still working (keep polling)
  • completed - AI finished; read the clarification in the result field
  • cancelled - Request was cancelled
  • failed - An error occurred; see error field

Typical flow:

  1. POST /scenario-agent/ → receive progress_id
  2. Poll this endpoint every few seconds
  3. When status == 'completed', feed the answers into scenarios_generate_bg
get/test_framework/v2/scenarios/scenario-agent-progress/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v2/scenarios/scenario-agent-progress/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Query parameters

progress_idstring required

The progress_id returned by POST /scenario-agent/

Response

progress_idstring required
session_idinteger nullable required
modestring required

Always 'clarify'.

statusstring required

in_progress | completed | needs_clarification | cancelled | failed

resultobject nullable

ScenarioAgentResponseSerializer payload; null while status is in_progress

errorstring nullable

Error message when status is failed

Changes