> ## Documentation Index > Fetch the complete documentation index at: https://docs.zelto.ai/llms.txt > Use this file to discover all available pages before exploring further. # Retire a case > Leaves the next version; runs that used it keep it. ## OpenAPI ````yaml /docs-openapi.json post /v1/benchmarks/{id}/cases/{caseId}/retire openapi: 3.1.0 info: title: Zelto REST API version: v1 description: >- Programmatic access to your Zelto organization. Every endpoint is scoped to the organization the API key belongs to. Mint a key at Settings → Integrations → API integration. servers: - url: https://api.zelto.ai description: Production security: - bearerAuth: [] tags: - name: Monitors description: Filtered, asynchronous exports of stored monitor results. - name: Agents description: Voice and text agents normalised through Zelto's ingestion pipeline. - name: Conversations description: >- Phone calls, chats, and voicemails — plus their transcripts and recordings. - name: Customer Metrics description: >- Customer-provided evaluations attached to a conversation (requires metrics enabled). - name: Reviews description: Human review state for conversations. - name: Buckets description: Reviewer routing — group conversations for batched review. - name: Companies description: Clients or brands your agents work for, and their logos. - name: Findings description: >- Structured issues discovered during analysis, with optional conversation attachments and comments. - name: Experiments description: >- Prospective measurement of two externally routed prompt versions across independent monitor outcomes. - name: Organizations description: >- Headless org provisioning. Requires an admin/service API key (not a read-only org-scoped customer key). - name: AI providers description: >- Your organization's own (bring-your-own) AI provider keys. Monitors can run on them instead of Zelto's built-in models. Owner or admin keys only; the secret is write-only. - name: Benchmarks description: >- Repeatable evaluations of agent prompts, models and speech-to-text engines over a fixed set of cases, scored by Judges. paths: /v1/benchmarks/{id}/cases/{caseId}/retire: post: tags: - Benchmarks summary: Retire a case description: Leaves the next version; runs that used it keep it. operationId: retireBenchmarkCase parameters: - name: id in: path required: true description: Benchmark id. schema: type: string format: uuid - name: caseId in: path required: true description: Case id. schema: type: string format: uuid responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/BenchmarkCase' '400': $ref: '#/components/responses/ValidationFailed' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: schemas: BenchmarkCase: type: object properties: id: type: string revision: type: integer type: type: string enum: - turn - conversation - audio title: type: string checkGroupId: type: - string - 'null' source: type: string enum: - production - trace - manual - red_team - api - mcp - upload sourceConversationId: type: - string - 'null' sourceAgent: anyOf: - $ref: '#/components/schemas/BenchmarkAgentRef' - type: 'null' sourceAgentVersionLabel: description: The agent prompt version the case was written against, e.g. "v7". type: string tags: type: array items: type: string language: type: - string - 'null' retired: type: boolean draft: type: boolean referenceUnverified: description: >- audio: the reference transcript came from the call and nobody has checked it yet. The case still runs. type: boolean unpublished: type: boolean preview: type: string skippedJudgeIds: type: array items: type: string judgeParamOverrides: type: object propertyNames: type: string minLength: 1 maxLength: 100 additionalProperties: type: object propertyNames: type: string minLength: 1 maxLength: 100 additionalProperties: anyOf: - type: number - type: string maxLength: 500 addedInVersion: anyOf: - type: integer - type: 'null' retiredInVersion: anyOf: - type: integer - type: 'null' toolExpectation: $ref: '#/components/schemas/BenchmarkToolExpectation' replyExpectation: $ref: '#/components/schemas/BenchmarkReplyExpectation' traceSource: type: object properties: kind: type: string const: trace traceId: type: string spanId: type: - string - 'null' turns: type: string enum: - transcript - span_messages required: - kind - traceId - spanId - turns status: type: string enum: - ready - draft - preparing - failed contentPurged: type: boolean contentDeleted: description: >- "Delete all call content" blanked this case: content and Judge reasoning are gone, the title is a neutral "Case N · content deleted", scores stay. type: boolean createdAt: type: string description: ISO 8601 timestamp. updatedAt: type: string description: ISO 8601 timestamp. required: - id - revision - type - title - checkGroupId - source - sourceConversationId - sourceAgent - tags - language - retired - draft - preview description: 'A case: one input the candidates are scored on.' BenchmarkAgentRef: type: object properties: id: type: string name: type: string required: - id - name description: An agent the benchmark is assigned to. BenchmarkToolExpectation: type: object properties: expect: type: string enum: - call - no_call - any calls: maxItems: 10 type: array items: type: object properties: tool: type: string minLength: 1 maxLength: 100 pattern: ^[A-Za-z0-9_.:-]+$ arguments: type: object propertyNames: type: string minLength: 1 maxLength: 100 additionalProperties: oneOf: - type: object properties: op: type: string const: equals value: {} required: - op - value - type: object properties: op: type: string const: one_of values: minItems: 1 maxItems: 50 type: array items: {} required: - op - values - type: object properties: op: type: string const: regex pattern: type: string minLength: 1 maxLength: 500 required: - op - pattern - type: object properties: op: type: string const: number_range min: type: number max: type: number required: - op - type: object properties: op: type: string const: present required: - op - type: object properties: op: type: string const: semantic description: type: string minLength: 1 maxLength: 500 required: - op - description - type: object properties: op: type: string const: ignore required: - op required: - tool - arguments ordered: type: boolean forbiddenTools: maxItems: 50 type: array items: type: string minLength: 1 maxLength: 100 pattern: ^[A-Za-z0-9_.:-]+$ noExtraArguments: type: boolean replyAt: type: integer minimum: 0 maximum: 10 required: - expect description: Which tool call(s) a turn case expects. BenchmarkReplyExpectation: type: object properties: check: type: string enum: - reference - different - none text: anyOf: - type: string maxLength: 20000 - type: 'null' idealReply: anyOf: - type: string maxLength: 20000 - type: 'null' required: - check description: How the spoken reply of a turn case is checked. Error: type: object required: - error properties: error: type: string description: >- Short error name: `Unauthorized`, `Validation failed`, `Not found`, or a stable snake_case code you can match on, such as `unknown_query_parameter`, `invalid_parameter`, `payload_too_large` or `not_found`. message: type: string description: A plain-English sentence saying what is wrong and how to fix it. code: type: string description: >- Stable, machine-readable cause; match on this rather than on `error` or `message`. On a 401: `missing_credentials`, `malformed_credentials`, `ingest_key_not_allowed` (a write-only observability ingest key was used on an endpoint that needs an API key), `key_expired` or `invalid_credentials`. Elsewhere, for example: `not_found`, `invalid_parameter`, `unknown_query_parameter`, `missing_parameter`, `validation_failed`, `invalid_json`, `payload_too_large`, `conversation_not_found`, `plan_required`. hint: type: string description: >- The next step to try: where to find the right id, which parameters the endpoint takes, how to upgrade the plan, how to authenticate. parameter: type: string description: 'With `invalid_parameter`: the query parameter that was rejected.' unknown: type: array items: type: string description: >- With `unknown_query_parameter`: the parameters that were sent but are not accepted here. valid: type: array items: type: string description: >- With `unknown_query_parameter`: the parameters this endpoint accepts. details: type: object additionalProperties: true responses: ValidationFailed: description: >- The request body or query string failed validation. `code` says which kind (`validation_failed`, `invalid_json`, `invalid_parameter`, `unknown_query_parameter`, `missing_parameter`), and an enum filter names the allowed values in `valid` (every repeated value is checked, e.g. `?status=open&status=zz` is a 400). A `validation_failed` body also carries `message` (the first failing fields), `hint` (how to fix it, for example that a finding `description` is a TipTap JSON document and not a string) and `details` (field name to messages). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: >- Missing or invalid API key. The body names the cause in `code` (for example `ingest_key_not_allowed` when a write-only ingest key is used here) with a `message` and `hint`. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: >- Resource not found in your organization. Also returned when a path id is not a UUID, and `{ "error": "not_found" }` for a path this API does not have. The body keeps `error: "Not found"` and adds `code: "not_found"` and a `hint`. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Send `Authorization: Bearer YOUR_API_KEY`. The key resolves to a single organization. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.