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

# Responses

> OpenAI Responses API compatible endpoint. Supports streaming via the stream parameter.



## OpenAPI

````yaml post /v3/compat/responses
openapi: 3.1.0
info:
  description: Schema-driven generative API that orchestrates LLM-powered workflows.
  title: Task API
  version: 3.0.0
servers:
  - description: Production
    url: https://api.opper.ai
  - description: Local development
    url: http://localhost:8080
security:
  - BearerAuth: []
tags:
  - description: Schema-driven function management and execution
    name: Functions
  - description: OpenAI-compatible chat completions
    name: Chat
  - description: OpenAI Responses API compatible endpoint
    name: Responses
  - description: Google-compatible interactions endpoint
    name: Interactions
  - description: Model registry and capabilities
    name: Models
  - description: Synchronous image generation
    name: Images
  - description: Text-to-speech and speech-to-text
    name: Audio
  - description: Asynchronous video generation
    name: Videos
  - description: Reusable file storage for media inputs and generated outputs
    name: Files
  - description: Async generation status and downloads
    name: Artifacts
  - description: OpenAI-compatible embeddings
    name: Embeddings
  - description: Recorded HTTP request/response generations
    name: Generations
  - description: System health and status
    name: System
  - description: Roundtable endpoint — fan out a query to multiple LLMs and combine results
    name: Roundtable
  - description: Web search, fetch, and other utility tools
    name: Tools
paths:
  /v3/compat/responses:
    post:
      tags:
        - Compatibility
      summary: Responses API
      description: >-
        OpenAI Responses API compatible endpoint. Supports streaming via the
        stream parameter.
      operationId: createResponse
      parameters:
        - description: >-
            Function name for tracing and project-level guardrail function-scope
            filtering.
          in: header
          name: X-Opper-Name
          schema:
            type: string
        - description: Parent span ID for distributed tracing context.
          in: header
          name: X-Opper-Parent-Span-Id
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponsesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesResponse'
            text/event-stream:
              schema:
                description: >-
                  Server-Sent Events stream following the OpenAI Responses
                  streaming protocol. Each event has an `event:` line and a
                  `data: <json>` line. The stream terminates with a
                  `response.completed` event whose payload carries the final
                  `usage` (token counts and Opper `cost` extension).
                type: string
          description: Successful response
          headers:
            X-Opper-Cost:
              description: Execution cost of the request as a floating-point number.
              schema:
                format: double
                type: number
        '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
components:
  schemas:
    ResponsesRequest:
      properties:
        frequency_penalty:
          type: number
        include:
          items:
            type: string
          type: array
        input:
          properties:
            Items:
              items:
                properties:
                  type:
                    type: string
                required:
                  - type
                type: object
              type: array
            Text:
              type: string
          required:
            - Text
            - Items
          type: object
        instructions:
          type: string
        max_output_tokens:
          type: integer
        metadata:
          type: object
        model:
          type: string
        parallel_tool_calls:
          type: boolean
        presence_penalty:
          type: number
        previous_response_id:
          type: string
        reasoning:
          properties:
            effort:
              type: string
            summary:
              type: string
          type: object
        service_tier:
          type: string
        store:
          type: boolean
        stream:
          type: boolean
        temperature:
          type: number
        text:
          properties:
            format:
              properties:
                name:
                  type: string
                schema:
                  type: object
                type:
                  type: string
              required:
                - type
              type: object
          type: object
        tool_choice:
          description: Any value
        tools:
          items:
            properties:
              description:
                type: string
              headers:
                additionalProperties:
                  type: string
                type: object
              name:
                type: string
              parameters:
                type: object
              require_approval:
                type: string
              server_label:
                type: string
              server_url:
                type: string
              type:
                type: string
            required:
              - type
            type: object
          type: array
        top_p:
          type: number
        truncation:
          type: string
        user:
          type: string
      type: object
    ResponsesResponse:
      properties:
        completed_at:
          type: integer
        cost:
          type: number
        created_at:
          type: number
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
        frequency_penalty:
          type: number
        id:
          type: string
        incomplete_details:
          description: Any value
        instructions:
          type: string
        max_output_tokens:
          type: integer
        metadata:
          type: object
        model:
          type: string
        object:
          type: string
        output:
          items:
            properties:
              arguments:
                type: string
              call_id:
                type: string
              content:
                items:
                  properties:
                    annotations:
                      items:
                        description: Any value
                      type: array
                    text:
                      type: string
                    type:
                      type: string
                  required:
                    - type
                    - text
                  type: object
                type: array
              encrypted_content:
                type: string
              id:
                type: string
              name:
                type: string
              role:
                type: string
              status:
                type: string
              summary:
                items:
                  properties:
                    text:
                      type: string
                    type:
                      type: string
                  required:
                    - type
                    - text
                  type: object
                type: array
              type:
                type: string
            required:
              - type
            type: object
          type: array
        output_text:
          type: string
        parallel_tool_calls:
          type: boolean
        presence_penalty:
          type: number
        previous_response_id:
          type: string
        reasoning:
          properties:
            effort:
              type: string
            summary:
              type: string
          type: object
        service_tier:
          type: string
        status:
          type: string
        temperature:
          type: number
        text:
          properties:
            format:
              properties:
                name:
                  type: string
                schema:
                  type: object
                type:
                  type: string
              required:
                - type
              type: object
          type: object
        tool_choice:
          description: Any value
        tools:
          items:
            properties:
              description:
                type: string
              headers:
                additionalProperties:
                  type: string
                type: object
              name:
                type: string
              parameters:
                type: object
              require_approval:
                type: string
              server_label:
                type: string
              server_url:
                type: string
              type:
                type: string
            required:
              - type
            type: object
          type: array
        top_p:
          type: number
        truncation:
          type: string
        usage:
          properties:
            cost:
              type: number
            input_tokens:
              type: integer
            input_tokens_details:
              properties:
                cached_tokens:
                  type: integer
              type: object
            output_tokens:
              type: integer
            output_tokens_details:
              properties:
                reasoning_tokens:
                  type: integer
              type: object
            total_tokens:
              type: integer
          required:
            - input_tokens
            - output_tokens
            - total_tokens
          type: object
        user:
          type: string
      required:
        - id
        - object
        - created_at
        - model
        - status
        - output
        - error
        - incomplete_details
        - tool_choice
      type: object
    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
  securitySchemes:
    BearerAuth:
      bearerFormat: API Key
      description: API key authentication. Pass your API key as a Bearer token.
      scheme: bearer
      type: http

````