Opper AI Traces API

openapi: 3.2.0
info:
  description: Schema-driven generative API that orchestrates LLM-powered workflows.
  title: Task Traces API
  version: 3.0.0
servers:
- description: Production
  url: https://api.opper.ai
- description: Local development
  url: http://localhost:8080
security:
- BearerAuth: []
tags:
- name: Traces
paths:
  /v3/traces:
    get:
      description: List traces with pagination.
      operationId: listTraces
      parameters:
      - description: Max items to return (default 100, max 100)
        in: query
        name: limit
        schema:
          default: 100
          type: integer
      - description: Number of items to skip (default 0)
        in: query
        name: offset
        schema:
          default: 0
          type: integer
      - description: Filter by trace name (case-insensitive substring match)
        in: query
        name: name
        schema:
          type: string
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '401':
          description: Unauthorized - missing or invalid API key
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      summary: List traces
      tags:
      - Traces
  /v3/traces/{id}:
    delete:
      description: Delete a trace and all its spans.
      operationId: deleteTrace
      parameters:
      - description: Generation ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '401':
          description: Unauthorized - missing or invalid API key
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      summary: Delete trace
      tags:
      - Traces
    get:
      description: Get a trace with all its spans.
      operationId: getTrace
      parameters:
      - description: Generation ID
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTraceResponse'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '401':
          description: Unauthorized - missing or invalid API key
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      summary: Get trace
      tags:
      - Traces
  /v3/traces/{id}/events:
    get:
      description: List all events across all spans in a trace.
      operationId: listTraceEvents
      parameters:
      - description: Generation ID
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Filter by event kind (guardrail, feedback, evaluation)
        in: query
        name: kind
        schema:
          type: string
      responses:
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '401':
          description: Unauthorized - missing or invalid API key
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      summary: List trace events
      tags:
      - Traces
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          properties:
            code:
              type: string
            details:
              description: Any value
            message:
              type: string
          required:
          - code
          - message
          type: object
        meta:
          type: object
      required:
      - error
      type: object
    GetTraceResponse:
      properties:
        data:
          properties:
            checks_cost:
              type: number
            completion_tokens:
              type: integer
            duration_ms:
              type: integer
            end_time:
              format: date-time
              type: string
            evaluation_cost:
              type: number
            events:
              items:
                properties:
                  created_at:
                    format: date-time
                    type: string
                  data:
                    type: object
                  id:
                    type: string
                  kind:
                    type: string
                  source:
                    type: string
                  span_id:
                    type: string
                  span_uuid:
                    type: string
                required:
                - id
                - span_id
                - kind
                - source
                - data
                type: object
              type: array
            id:
              type: string
            input:
              type: string
            model_cost:
              type: number
            name:
              type: string
            output:
              type: string
            prompt_tokens:
              type: integer
            span_count:
              type: integer
            spans:
              items:
                properties:
                  data:
                    properties:
                      cost:
                        type: number
                      evaluations:
                        items:
                          properties:
                            cost:
                              type: number
                            created_at:
                              type: string
                            duration_ms:
                              type: integer
                            evaluator_type:
                              type: string
                            explanation:
                              type: string
                            flagged:
                              type: boolean
                            generation_id:
                              type: string
                            id:
                              type: string
                            model:
                              type: string
                            rule_id:
                              type: string
                            score:
                              type: number
                          required:
                          - id
                          - generation_id
                          - flagged
                          - created_at
                          type: object
                        type: array
                      function:
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                        required:
                        - id
                        - name
                        type: object
                      generation_id:
                        type: string
                      input_truncated:
                        type: boolean
                      instructions:
                        type: string
                      model:
                        type: string
                      observations:
                        type: string
                      output_truncated:
                        type: boolean
                      score:
                        type: integer
                      scorer_context:
                        type: object
                      tags:
                        type: object
                      total_tokens:
                        type: integer
                    type: object
                  end_time:
                    format: date-time
                    type: string
                  error:
                    type: string
                  id:
                    type: string
                  input:
                    description: Any value
                  meta:
                    type: object
                  metadata:
                    type: object
                  metrics:
                    items:
                      properties:
                        comment:
                          type: string
                        created_at:
                          type: string
                        dimension:
                          type: string
                        id:
                          type: string
                        value:
                          type: number
                      required:
                      - id
                      - dimension
                      - value
                      - created_at
                      type: object
                    type: array
                  name:
                    type: string
                  output:
                    description: Any value
                  parent_id:
                    type: string
                  score:
                    type: integer
                  start_time:
                    format: date-time
                    type: string
                  status:
                    type: string
                  tags:
                    type: object
                  trace_id:
                    type: string
                  type:
                    type: string
                required:
                - id
                - trace_id
                - name
                type: object
              type: array
            start_time:
              format: date-time
              type: string
            status:
              type: string
            total_tokens:
              type: integer
          required:
          - id
          - span_count
          - spans
          type: object
      required:
      - data
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: API Key
      description: API key authentication. Pass your API key as a Bearer token.
      scheme: bearer
      type: http
    MCPBearer:
      description: Delegated user OAuth access token for the Opper MCP resource. Obtain through advertised OAuth authorization; runtime and management service keys are not accepted.
      scheme: bearer
      type: http
    ManagementBearer:
      bearerFormat: Management API Key
      description: Management API authentication. Pass an `op-mak-…` management token as a Bearer token. Runtime `op-…` API keys are rejected with 403 — they belong on the data-plane endpoints. Mint a management key from the platform UI under Settings → API keys.
      scheme: bearer
      type: http