> ## Documentation Index > Fetch the complete documentation index at: https://docs.support.onclarity.com/llms.txt > Use this file to discover all available pages before exploring further. # List eval scenarios > Returns every scenario of the project with its test cases, so you can reuse one in a suite by `scenario_id`. Scenarios are created and changed through the eval suite endpoints. ## OpenAPI ````yaml api-reference/voice-openapi.json GET /v1/projects/{projectId}/eval-scenarios openapi: 3.0.3 info: title: Clarity Voice API version: '1.0' description: >- Voice agents and their tools, outbound calls, conversations, campaigns, telephony, and evals. servers: - url: https://voice-api.onclarity.com security: - organizationApiKey: [] tags: - name: Projects description: >- The projects your organization owns. Every other resource lives in a project. - name: Agents description: Create, configure, version and publish voice agents. - name: Outbound calls description: Have a published agent phone a number now. - name: Conversations description: >- One record per call session, with its calls, recordings, transcripts and artifacts. - name: Calls description: The calls of a project, with their status, direction, timing and outcome. - name: Campaigns description: Outbound calling campaigns that phone a list of numbers on a schedule. - name: Eval suites description: >- Reusable sets of eval scenarios and test cases to measure an agent against. - name: Eval judges description: The LLM judges that score eval calls against your test cases. - name: Eval scenarios description: The simulated-caller scenarios of your eval suites. - name: Eval test cases description: The checks a judge applies to each eval call. - name: Eval submissions description: Run an eval suite against an agent and read the verdicts. - name: Phone numbers description: >- The phone numbers of a project, where their calls come from, and how agents call out from them. - name: Inbound SIP trunks description: Bring calls from your own SIP infrastructure to Clarity agents. - name: Outbound SIP trunks description: >- The SIP endpoints Clarity dials through for outbound calls from your numbers. - name: Tools description: The tools agents call during a conversation, and which agents use them. paths: /v1/projects/{projectId}/eval-scenarios: parameters: - $ref: '#/components/parameters/ProjectIdPath' get: tags: - Eval scenarios summary: List eval scenarios description: >- Returns every scenario of the project with its test cases, so you can reuse one in a suite by `scenario_id`. Scenarios are created and changed through the eval suite endpoints. operationId: listEvalScenarios responses: '200': description: The project's scenarios content: application/json: schema: type: object required: - scenarios properties: scenarios: type: array items: $ref: '#/components/schemas/EvalScenario' example: scenarios: - id: b2a4c6e8-0f1d-4e3b-9c5a-7e9f1b3d5c7a project_id: 4f3a9b2c-1d2e-4f5a-8b6c-7d8e9f0a1b2c name: Book a table for two description: null simulator_config: prompt: You are Sara. You want a table for two tomorrow at 8 pm. max_turns: 20 test_case_ids: - c3d5e7f9-1a2b-4c3d-8e4f-5a6b7c8d9e0f field_overrides: {} silence_modes: null test_cases: [] created_by: org-token:42 created_at: '2026-10-01T09:30:00.000Z' updated_at: '2026-10-01T09:30:00.000Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: ProjectIdPath: name: projectId in: path required: true schema: type: string description: Project id schemas: EvalScenario: type: object description: >- A simulated caller (persona and goal) together with the test cases its calls are judged against. required: - id - project_id - name - simulator_config - test_case_ids properties: id: type: string project_id: type: string name: type: string maxLength: 256 description: type: string nullable: true simulator_config: $ref: '#/components/schemas/EvalSimulatorConfig' test_case_ids: type: array items: type: string field_overrides: type: object additionalProperties: type: string description: >- Values for the agent's prompt fields used in this scenario's calls. They are merged over the suite's `field_overrides` (the scenario wins on the same key). Keys must be fields the agent allows to be overridden. silence_modes: type: array nullable: true items: $ref: '#/components/schemas/EvalSilenceMode' description: >- The silence behaviors this scenario runs under; each entry is run separately. `null` means not set: the submission's own silence setting applies. test_cases: type: array description: The scenario's test cases, in order. items: $ref: '#/components/schemas/EvalTestCase' created_by: type: string nullable: true created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true EvalSimulatorConfig: type: object description: How the simulated caller behaves in this scenario. required: - prompt - max_turns properties: prompt: type: string description: >- Instructions for the simulated caller (who they are, what they want, how they behave). max_turns: type: integer minimum: 1 maximum: 100 description: The most caller turns before the call is ended. close_instruction: type: string maxLength: 4000 description: >- Optional instruction for how the simulated caller ends the call. Omitted means the platform default: the agent closes the call and the caller hangs up only as a last resort. additionalProperties: true EvalSilenceMode: type: string enum: - 'off' - always - flexible description: >- How the simulated caller handles silences: `off` never stays silent, `always` and `flexible` test how the agent copes with a quiet caller. EvalTestCase: type: object description: >- One check the judge applies to an eval call: when it is relevant, what counts as success and what counts as failure. required: - id - project_id - name - when_relevant - success_criteria - failure_criteria properties: id: type: string project_id: type: string name: type: string maxLength: 256 description: type: string nullable: true when_relevant: type: string description: >- When this test case applies to a call. A call where it does not apply is judged `not_relevant`. success_criteria: type: string description: What the agent must do for the test case to pass. failure_criteria: type: string description: What makes the test case fail. created_by: type: string nullable: true created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true Error: type: object required: - error additionalProperties: true properties: error: type: string description: Error message code: type: string description: >- A stable machine-readable reason, present on the refusals a client may branch on. Among them: `PUBLISH_CAPABILITY_REQUIRED` (403, the credential may not change what is live), `AGENT_NOT_PUBLISHED` (409, the agent has no published version yet), `AGENT_TYPE_NOT_DISPATCHABLE` (422, a Voice Assist agent named where an agent must place a call or answer one itself — a campaign, an outbound caller ID, a dispatched call, an eval; a number's inbound dispatch rule accepts one; the body carries `agent_type` and `agent_id`), `ASSIST_FLEET_NOT_CONFIGURED` (422 on a dispatch rule naming a Voice Assist agent in a project whose LiveKit has no Voice Assist listener), `NOT_APPLICABLE_TO_AGENT_TYPE` (422, a voice-only setting written on a Voice Assist agent), `AGENT_TYPE_BOUNDARY` (409), `AGENT_TYPE_NOT_SUPPORTED` (400), `INVALID_CUSTOMER_TIMEZONE` (400, `customer_timezone` is not a time zone name; the body carries the value), `VOICE_ASSISTANT_REQUIRED` (403, the organization is not licensed for Voice Assist), `ORGANIZATION_UNAVAILABLE` (503), `REGION_PROFILE_CONFLICT` (503), `LLM_SERVICE_TIER_UNAVAILABLE` (422, an agent's processing speed is not offered by its model or not enabled for the organization; `reason` says which) and `AUTH_UPSTREAM_UNAVAILABLE` (503 on any endpoint, with `Retry-After`: the credential could not be checked right now; it was not rejected and the request was not carried out). responses: Unauthorized: description: >- No credential was sent, or the API key is invalid or revoked. A key that could not be checked at all answers 503 `AUTH_UPSTREAM_UNAVAILABLE` instead (see Errors). content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid or revoked token Forbidden: description: >- The credential carries no access to this project, or the operation needs administrative rights content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: No such resource on this project content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: organizationApiKey: type: http scheme: bearer description: >- Your organization API key (it starts with `anek_org_`). The same key works on the Voice API and the Support API. See [Authentication](/authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.