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

# Get a dead-letter failure

> Returns the detail and error message for a dead-letter queue failure.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/admin/dlq/{failure_id}
openapi: 3.1.0
info:
  description: >-
    Splendor is a search and retrieval API for your operational data. Ingest

    datasets — logs, documents, and structured records — and query them through
    one

    consistent interface that spans full-text, SQL, and semantic (vector)
    search.


    Every request authenticates with a bearer token and selects a workspace with
    the

    `X-Splendor-Tenant-Id` header. Read and query operations are available to
    any

    member; operations that create, change, or delete data require an admin
    role.


    All search modes return one shared envelope, and every result carries
    provenance

    back to the exact source object it came from.
  title: Splendor API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.withsplendor.com
security:
  - bearerAuth: []
tags:
  - description: Resolve the authenticated user and the tenants they can access.
    name: Identity
  - description: >-
      Build on Splendor as a platform: authenticate with a platform API key to
      provision an isolated tenant per end-customer and manage your platform
      keys.
    name: Platform
  - description: >-
      List datasets, inspect inferred schemas and readiness, and manage dataset
      lifecycle including deletion and schema rebuilds.
    name: Datasets & schema
  - description: >-
      Run full-text, SQL, and semantic search over your datasets, stream
      results, and resolve object media.
    name: Search & query
  - description: Save queries and materialize result sets for repeatable analysis.
    name: Views
  - description: >-
      Define named, versioned, parameterized SQL queries and manage their
      versions.
    name: Query Endpoints
  - description: Create and manage asynchronous exports of search results.
    name: Exports
  - description: >-
      Configure data sources, upload data through hosted multipart uploads,
      stream logs, and track ingest runs.
    name: Sources & ingest
  - description: >-
      Connect third-party systems by managing connector instances in the
      selected tenant.
    name: Connectors
  - description: Define and test detection rules that run against incoming data.
    name: Detections
  - description: Inspect discovered fields and promote them to fast, aggregatable fields.
    name: Fields
  - description: >-
      Operational visibility and recovery: audit logs, usage, dead-letter queue,
      reindex jobs, and data-deletion jobs.
    name: Operations
paths:
  /v1/admin/dlq/{failure_id}:
    get:
      tags:
        - Operations
      summary: Get a dead-letter failure
      description: Returns the detail and error message for a dead-letter queue failure.
      operationId: getDlqFailure
      parameters:
        - in: path
          name: failure_id
          required: true
          schema:
            title: Failure Id
            type: integer
        - in: query
          name: tenant_id
          required: true
          schema:
            minLength: 1
            title: Tenant Id
            type: string
        - $ref: '#/components/parameters/SplendorTenantId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IngestFailureItem'
          description: Successful Response
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested resource was not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  parameters:
    SplendorTenantId:
      description: Selects the tenant (workspace) the request acts within.
      in: header
      name: x-splendor-tenant-id
      required: true
      schema:
        type: string
  schemas:
    IngestFailureItem:
      example:
        committed_batch_count: 0
        committed_document_count: 0
        dataset_id: app-logs
        error_message: Failed to parse record at line 10
        error_type: ParseError
        failed_at: '2026-01-15T09:30:00Z'
        failed_document_count: 1
        failed_document_offset: 10
        failure_id: 1
        last_retry_at: null
        repair_kind: null
        repair_started_at: null
        retry_count: 0
        retryable: true
        s3_bucket: acme-logs
        s3_etag: '"5d41402a"'
        s3_key: 2026/01/15/app-bad.jsonl.gz
        source: app-logs
        source_id: 12
        status: failed
        tenant_id: acme
      properties:
        committed_batch_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Committed Batch Count
        committed_document_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Committed Document Count
        dataset_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Dataset Id
        error_message:
          title: Error Message
          type: string
        error_type:
          title: Error Type
          type: string
        failed_at:
          format: date-time
          title: Failed At
          type: string
        failed_document_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Failed Document Count
        failed_document_offset:
          anyOf:
            - type: integer
            - type: 'null'
          title: Failed Document Offset
        failure_id:
          title: Failure Id
          type: integer
        last_retry_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Last Retry At
        repair_kind:
          anyOf:
            - type: string
            - type: 'null'
          title: Repair Kind
        repair_started_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Repair Started At
        retry_count:
          title: Retry Count
          type: integer
        retryable:
          title: Retryable
          type: boolean
        s3_bucket:
          title: S3 Bucket
          type: string
        s3_etag:
          anyOf:
            - type: string
            - type: 'null'
          title: S3 Etag
        s3_key:
          title: S3 Key
          type: string
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
        source_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Source Id
        status:
          title: Status
          type: string
        tenant_id:
          title: Tenant Id
          type: string
      required:
        - failure_id
        - tenant_id
        - source_id
        - dataset_id
        - source
        - s3_bucket
        - s3_key
        - s3_etag
        - error_message
        - error_type
        - failed_at
        - retry_count
        - last_retry_at
        - status
        - retryable
        - repair_kind
        - repair_started_at
        - committed_document_count
        - committed_batch_count
        - failed_document_offset
        - failed_document_count
      title: IngestFailureItem
      type: object
    ApiError:
      description: >-
        Error envelope returned by every Splendor API endpoint.


        ``detail`` is either a plain message string (most errors) or a
        structured

        ``{code, message}`` object (validation and capacity errors that carry a
        stable

        machine-readable code).
      examples:
        - detail: Dataset not found
        - detail:
            code: semantic_search_capacity_exhausted
            message: Semantic search capacity is temporarily exhausted; retry shortly.
      properties:
        detail:
          anyOf:
            - type: string
            - $ref: '#/components/schemas/ErrorBody'
          title: Detail
      required:
        - detail
      title: ApiError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ErrorBody:
      description: Structured error detail returned by validation and capacity errors.
      examples:
        - code: semantic_query_text_required
          message: Semantic vector search requires non-empty text.
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
      required:
        - code
        - message
      title: ErrorBody
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: The bearer token is missing, malformed, or expired.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: The token lacks access to the tenant or the role required.
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: API token issued from the Splendor console.
      scheme: bearer
      type: http

````