> ## 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. # OpenResponses > OpenResponses-compatible endpoint with multi-provider support and opper: extension items. ## OpenAPI ````yaml post /v3/compat/openresponses 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/openresponses: post: tags: - Compatibility summary: OpenResponses API description: >- OpenResponses-compatible endpoint with multi-provider support and opper: extension items. operationId: createOpenResponse 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/ORRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ORResponse' text/event-stream: schema: description: >- Server-Sent Events stream. Each event has an `event:` line and a `data: ` line; the payload's `type` field discriminates the event. The stream terminates with a `response.completed` event whose payload carries the final `usage` (token counts and `cost`). discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/ORStreamEventResponseCreated' - $ref: '#/components/schemas/ORStreamEventResponseInProgress' - $ref: '#/components/schemas/ORStreamEventOutputItemAdded' - $ref: '#/components/schemas/ORStreamEventContentPartAdded' - $ref: '#/components/schemas/ORStreamEventOutputTextDelta' - $ref: '#/components/schemas/ORStreamEventOutputTextDone' - $ref: '#/components/schemas/ORStreamEventContentPartDone' - $ref: '#/components/schemas/ORStreamEventReasoningSummaryDelta' - $ref: '#/components/schemas/ORStreamEventReasoningSummaryDone' - $ref: >- #/components/schemas/ORStreamEventFunctionCallArgumentsDelta - $ref: >- #/components/schemas/ORStreamEventFunctionCallArgumentsDone - $ref: '#/components/schemas/ORStreamEventOutputItemDone' - $ref: '#/components/schemas/ORStreamEventCompleted' - $ref: '#/components/schemas/ORStreamEventError' 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: ORRequest: 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 max_tool_calls: 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 name: type: string parameters: type: object strict: type: boolean type: type: string required: - type type: object type: array top_p: type: number truncation: type: string type: object ORResponse: properties: completed_at: type: integer created_at: type: integer error: properties: code: type: string message: type: string param: type: string type: type: string required: - message - type 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: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 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 name: type: string parameters: type: object strict: type: boolean type: type: string required: - type type: object type: array top_p: type: number truncation: type: string usage: properties: cost: description: >- Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header. type: number input_tokens: type: integer input_tokens_details: properties: cached_tokens: type: integer required: - cached_tokens type: object output_tokens: type: integer output_tokens_details: properties: reasoning_tokens: type: integer required: - reasoning_tokens type: object total_tokens: type: integer required: - input_tokens - output_tokens - total_tokens type: object required: - id - object - created_at - completed_at - status - model - output - error - incomplete_details - tool_choice type: object ORStreamEventResponseCreated: properties: response: properties: completed_at: type: integer created_at: type: integer error: properties: code: type: string message: type: string param: type: string type: type: string required: - message - type 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: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 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 name: type: string parameters: type: object strict: type: boolean type: type: string required: - type type: object type: array top_p: type: number truncation: type: string usage: properties: cost: description: >- Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header. type: number input_tokens: type: integer input_tokens_details: properties: cached_tokens: type: integer required: - cached_tokens type: object output_tokens: type: integer output_tokens_details: properties: reasoning_tokens: type: integer required: - reasoning_tokens type: object total_tokens: type: integer required: - input_tokens - output_tokens - total_tokens type: object required: - id - object - created_at - completed_at - status - model - output - error - incomplete_details - tool_choice type: object sequence_number: type: integer type: enum: - response.created type: string required: - type - sequence_number - response title: response.created type: object ORStreamEventResponseInProgress: properties: response: properties: completed_at: type: integer created_at: type: integer error: properties: code: type: string message: type: string param: type: string type: type: string required: - message - type 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: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 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 name: type: string parameters: type: object strict: type: boolean type: type: string required: - type type: object type: array top_p: type: number truncation: type: string usage: properties: cost: description: >- Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header. type: number input_tokens: type: integer input_tokens_details: properties: cached_tokens: type: integer required: - cached_tokens type: object output_tokens: type: integer output_tokens_details: properties: reasoning_tokens: type: integer required: - reasoning_tokens type: object total_tokens: type: integer required: - input_tokens - output_tokens - total_tokens type: object required: - id - object - created_at - completed_at - status - model - output - error - incomplete_details - tool_choice type: object sequence_number: type: integer type: enum: - response.in_progress type: string required: - type - sequence_number - response title: response.in_progress type: object ORStreamEventOutputItemAdded: properties: item: properties: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 output_index: type: integer sequence_number: type: integer type: enum: - response.output_item.added type: string required: - type - sequence_number - output_index - item title: response.output_item.added type: object ORStreamEventContentPartAdded: properties: content_index: type: integer item_id: type: string output_index: type: integer part: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object sequence_number: type: integer type: enum: - response.content_part.added type: string required: - type - sequence_number - item_id - output_index - content_index - part title: response.content_part.added type: object ORStreamEventOutputTextDelta: properties: content_index: type: integer delta: type: string item_id: type: string output_index: type: integer sequence_number: type: integer type: enum: - response.output_text.delta type: string required: - type - sequence_number - item_id - output_index - content_index - delta title: response.output_text.delta type: object ORStreamEventOutputTextDone: properties: content_index: type: integer item_id: type: string output_index: type: integer sequence_number: type: integer text: type: string type: enum: - response.output_text.done type: string required: - type - sequence_number - item_id - output_index - content_index - text title: response.output_text.done type: object ORStreamEventContentPartDone: properties: content_index: type: integer item_id: type: string output_index: type: integer part: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object sequence_number: type: integer type: enum: - response.content_part.done type: string required: - type - sequence_number - item_id - output_index - content_index - part title: response.content_part.done type: object ORStreamEventReasoningSummaryDelta: properties: delta: type: string item_id: type: string output_index: type: integer sequence_number: type: integer summary_index: type: integer type: enum: - response.reasoning_summary_text.delta type: string required: - type - sequence_number - item_id - output_index - summary_index - delta title: response.reasoning_summary_text.delta type: object ORStreamEventReasoningSummaryDone: properties: item_id: type: string output_index: type: integer sequence_number: type: integer summary_index: type: integer text: type: string type: enum: - response.reasoning_summary_text.done type: string required: - type - sequence_number - item_id - output_index - summary_index - text title: response.reasoning_summary_text.done type: object ORStreamEventFunctionCallArgumentsDelta: properties: delta: type: string item_id: type: string output_index: type: integer sequence_number: type: integer type: enum: - response.function_call_arguments.delta type: string required: - type - sequence_number - item_id - output_index - delta title: response.function_call_arguments.delta type: object ORStreamEventFunctionCallArgumentsDone: properties: arguments: type: string item_id: type: string output_index: type: integer sequence_number: type: integer type: enum: - response.function_call_arguments.done type: string required: - type - sequence_number - item_id - output_index - arguments title: response.function_call_arguments.done type: object ORStreamEventOutputItemDone: properties: item: properties: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 output_index: type: integer sequence_number: type: integer type: enum: - response.output_item.done type: string required: - type - sequence_number - output_index - item title: response.output_item.done type: object ORStreamEventCompleted: properties: response: properties: completed_at: type: integer created_at: type: integer error: properties: code: type: string message: type: string param: type: string type: type: string required: - message - type 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: action: type: string arguments: type: string cache_creation_tokens: type: integer cache_read_tokens: type: integer call_id: type: string content: items: properties: annotations: items: description: Any value type: array refusal: type: string text: type: string type: type: string required: - type - text type: object type: array cost_usd: type: number encrypted_content: type: string execution_ms: type: integer findings: items: description: Any value type: array flagged: type: boolean guard_type: type: string id: type: string model_warnings: items: type: string type: array models_used: items: type: string type: array 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 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 name: type: string parameters: type: object strict: type: boolean type: type: string required: - type type: object type: array top_p: type: number truncation: type: string usage: properties: cost: description: >- Opper extension: execution cost in USD. Present on streaming response.completed events; non-stream surfaces the same value via the X-Opper-Cost header. type: number input_tokens: type: integer input_tokens_details: properties: cached_tokens: type: integer required: - cached_tokens type: object output_tokens: type: integer output_tokens_details: properties: reasoning_tokens: type: integer required: - reasoning_tokens type: object total_tokens: type: integer required: - input_tokens - output_tokens - total_tokens type: object required: - id - object - created_at - completed_at - status - model - output - error - incomplete_details - tool_choice type: object sequence_number: type: integer type: enum: - response.completed type: string required: - type - sequence_number - response title: response.completed type: object ORStreamEventError: properties: error: properties: code: type: string message: type: string param: type: string type: type: string required: - message - type type: object sequence_number: type: integer type: enum: - error type: string required: - type - sequence_number - error title: error 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 ````