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

# Get evaluation retirement

> Read the immutable audit receipt referenced by an evaluation.retired event or the retirement action's Location. Requires plugins:admin and grants covering the original request's entire Corpus scope; a deployment-wide request requires a key granting all Corpora. Unknown, another Organization's and ungranted receipts all answer 404 not_found.



## OpenAPI

````yaml /openapi.yaml get /v0/admin/subscriptions/evaluation-retirements/{retirement_id}
openapi: 3.1.0
info:
  title: Quivr HTTP API
  version: 0.0.0-draft
  description: >-
    Every endpoint of the Quivr v0 HTTP API. Send an API key as a bearer token;
    the key decides the Organization, the actions and the Corpora a request may
    reach.
servers: []
security:
  - ApiKey: []
paths:
  /v0/admin/subscriptions/evaluation-retirements/{retirement_id}:
    get:
      tags:
        - Admin
      summary: Get evaluation retirement
      description: >-
        Read the immutable audit receipt referenced by an evaluation.retired
        event or the retirement action's Location. Requires plugins:admin and
        grants covering the original request's entire Corpus scope; a
        deployment-wide request requires a key granting all Corpora. Unknown,
        another Organization's and ungranted receipts all answer 404 not_found.
      operationId: getEvaluationRetirement
      parameters:
        - in: path
          name: retirement_id
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: The committed receipt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationRetirement'
        default:
          description: >-
            Structured error; 401 unauthenticated, 403 without plugins:admin,
            404 not_found, 503 storage unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    EvaluationRetirement:
      type: object
      additionalProperties: false
      required:
        - key
        - plugin_id
        - version
        - reason
        - dry_run
        - limit
        - retirement_id
        - outcome
        - items
        - remaining
        - leased
      properties:
        key:
          type: string
        plugin_id:
          type: string
        version:
          type: string
        reason:
          type: string
        dry_run:
          type: boolean
        limit:
          type: integer
          minimum: 1
          maximum: 500
        retirement_id:
          type: string
          minLength: 1
        created_at:
          type: string
          format: date-time
        outcome:
          type: string
          enum:
            - evaluator_retired
        items:
          type: array
          maxItems: 500
          items:
            $ref: '#/components/schemas/RetiredEvaluation'
        remaining:
          type: integer
          minimum: 0
          description: >-
            Unavailable pending evaluations remaining in this request's scope,
            including leased ones.
        leased:
          type: integer
          minimum: 0
          description: >-
            Unavailable pending evaluations skipped because their leases have
            not expired.
    Error:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        retryable:
          type: boolean
        field:
          type: string
          minLength: 1
          description: >-
            JSON Pointer (RFC 6901) to the request member that caused a 422,
            when known (for example /config/url or /credential/secret/token on
            connector commands).
        resync_url:
          type: string
          format: uri-reference
      required:
        - code
        - message
        - retryable
    RetiredEvaluation:
      type: object
      additionalProperties: false
      required:
        - subscription_id
        - subscription_version_id
        - sequence
        - corpus_id
        - record_id
        - record_version_id
      properties:
        subscription_id:
          type: string
        subscription_version_id:
          type: string
        sequence:
          type: integer
          format: int64
          description: The original trigger's Organization journal position.
        corpus_id:
          type: string
        record_id:
          type: string
        record_version_id:
          type: string
        event_id:
          type: string
          minLength: 1
          description: The evaluation.retired event; absent for a dry run.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        API key, not necessarily a JWT. Server derives Organization, permitted
        actions and Corpus scope; every resource access is authorized.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.