> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cekura.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Poll Improvement Progress

> Check the progress of an evaluator improvement request.



## OpenAPI

````yaml get /test_framework/v1/scenarios/scenario-agent-progress/
openapi: 3.1.0
info:
  title: Cekura API
  version: v1
  description: >-
    Complete API documentation for the Cekura platform. This API provides
    endpoints for testing, observing, and evaluating AI voice agents — including
    managing agents, running evaluators, defining metrics, and analyzing call
    quality.
servers:
  - url: https://api.cekura.ai
security: []
paths:
  /test_framework/v1/scenarios/scenario-agent-progress/:
    get:
      tags:
        - test_framework
      description: >-
        Check the progress of an evaluator improvement request.


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


        **Status values:**

        - `in_progress` - AI is analyzing and generating improvements (keep
        polling)

        - `completed` - AI finished; review suggestions in the `result` field

        - `needs_agent_clarification` - AI needs you to select an agent for some
        evaluators

        - `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'`, review the suggested changes

        4. POST /scenario-agent/ again with `apply_changes=true` to apply them
      operationId: scenarios-agent-progress_2
      parameters:
        - in: query
          name: progress_id
          schema:
            type: string
          description: The progress_id returned by POST /scenario-agent/
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScenarioAgentProgress'
          description: ''
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  field_name:
                    type: array
                    items:
                      type: string
          description: ''
      security:
        - api_key: []
components:
  schemas:
    ScenarioAgentProgress:
      type: object
      description: |-
        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
      properties:
        progress_id:
          type: string
        session_id:
          type:
            - integer
            - 'null'
        mode:
          type: string
          description: clarify or improve
        status:
          type: string
          description: >-
            in_progress | completed | needs_clarification |
            needs_agent_clarification | cancelled | failed
        result:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: >-
            ScenarioAgentResponseSerializer payload; null while status is
            in_progress
        error:
          type:
            - string
            - 'null'
          description: Error message when status is failed
      required:
        - mode
        - progress_id
        - session_id
        - status
  securitySchemes:
    api_key:
      type: apiKey
      name: X-CEKURA-API-KEY
      in: header
      description: >-
        API Key Authentication. It should be included in the header of each
        request.

````