openapi: 3.2.0 info: title: Chatbot Responses API description: Chatbot API. Provided by Multiverse Computing. contact: name: Multiverse Computing url: https://multiversecomputing.com/ email: contact@multiversecomputing.com version: 0.1.1 servers: - url: https://api.compactif.ai description: CompactifAI API production base URL (host the spec is served from; docs.compactif.ai documents this base) tags: - name: responses paths: /v1/responses/{response_id}: get: tags: - responses summary: Retrieve response description: 'Return a previously stored response, scoped to the authenticated user. Only responses created with ``store: true`` are available, and only to the user who created them.' operationId: get_response_v1_responses__response_id__get security: - HTTPBearer: [] parameters: - name: response_id in: path required: true schema: type: string title: Response Id - name: x-request-id in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Request-Id responses: '200': description: Stored response payload from /v1/responses content: application/json: schema: $ref: '#/components/schemas/ResponsesResult' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/responses: post: tags: - responses summary: Create response description: 'Generate a response from the model. Parameters: - **app_config**: Application configuration - **body**: ResponsesRequest payload with model and optional response parameters. - **authorization**: The authorization credentials. Returns: - A ResponsesResult for non-streaming requests. - A StreamingResponse when stream is true.' operationId: post_responses_v1_responses_post security: - HTTPBearer: [] parameters: - name: x-request-id in: header required: false schema: anyOf: - type: string - type: 'null' title: X-Request-Id - name: x-app-id in: header required: false schema: anyOf: - type: string - type: 'null' title: X-App-Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponsesRequest' responses: '200': description: Response payload (non-streaming). When stream=true a text/event-stream of response events is returned instead. content: application/json: schema: $ref: '#/components/schemas/ResponsesResult' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ActionScreenshot: properties: type: type: string const: screenshot title: Type additionalProperties: true type: object required: - type title: ActionScreenshot CodeInterpreterContainerCodeInterpreterToolAuto: properties: type: type: string const: auto title: Type file_ids: anyOf: - items: type: string type: array - type: 'null' title: File Ids additionalProperties: true type: object required: - type title: CodeInterpreterContainerCodeInterpreterToolAuto LocalShellCallAction: properties: command: items: type: string type: array title: Command env: additionalProperties: type: string type: object title: Env type: type: string const: exec title: Type timeout_ms: anyOf: - type: integer - type: 'null' title: Timeout Ms user: anyOf: - type: string - type: 'null' title: User working_directory: anyOf: - type: string - type: 'null' title: Working Directory additionalProperties: true type: object required: - command - env - type title: LocalShellCallAction ResponseFormatText: properties: type: type: string const: text title: Type additionalProperties: true type: object required: - type title: ResponseFormatText PendingSafetyCheck: properties: id: type: string title: Id code: type: string title: Code message: type: string title: Message additionalProperties: true type: object required: - id - code - message title: PendingSafetyCheck ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ResponseFormatJSONObject: properties: type: type: string const: json_object title: Type additionalProperties: true type: object required: - type title: ResponseFormatJSONObject Message: properties: content: items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseInputAudio' type: array title: Content role: type: string enum: - user - system - developer title: Role status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status type: anyOf: - type: string const: message - type: 'null' title: Type additionalProperties: true type: object required: - content - role title: Message ResponseInputImageContent: properties: type: type: string const: input_image title: Type detail: anyOf: - type: string enum: - low - high - auto - type: 'null' title: Detail file_id: anyOf: - type: string - type: 'null' title: File Id image_url: anyOf: - type: string - type: 'null' title: Image Url additionalProperties: true type: object required: - type title: ResponseInputImageContent FileSearchTool: properties: type: type: string const: file_search title: Type vector_store_ids: items: type: string type: array title: Vector Store Ids filters: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - $ref: '#/components/schemas/CompoundFilter' - type: 'null' title: Filters max_num_results: anyOf: - type: integer - type: 'null' title: Max Num Results ranking_options: anyOf: - $ref: '#/components/schemas/RankingOptions' - type: 'null' additionalProperties: true type: object required: - type - vector_store_ids title: FileSearchTool Reasoning: properties: effort: anyOf: - type: string enum: - minimal - low - medium - high - type: 'null' title: Effort generate_summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Generate Summary summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Summary additionalProperties: true type: object title: Reasoning LocalShellCallOutput: properties: id: type: string title: Id output: type: string title: Output type: type: string const: local_shell_call_output title: Type status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - id - output - type title: LocalShellCallOutput McpApprovalRequest: properties: id: type: string title: Id arguments: type: string title: Arguments name: type: string title: Name server_label: type: string title: Server Label type: type: string const: mcp_approval_request title: Type additionalProperties: true type: object required: - id - arguments - name - server_label - type title: McpApprovalRequest RankingOptions: properties: ranker: anyOf: - type: string enum: - auto - default-2024-11-15 - type: 'null' title: Ranker score_threshold: anyOf: - type: number - type: 'null' title: Score Threshold additionalProperties: true type: object title: RankingOptions McpCall: properties: id: type: string title: Id arguments: type: string title: Arguments name: type: string title: Name server_label: type: string title: Server Label type: type: string const: mcp_call title: Type approval_request_id: anyOf: - type: string - type: 'null' title: Approval Request Id error: anyOf: - type: string - type: 'null' title: Error output: anyOf: - type: string - type: 'null' title: Output status: anyOf: - type: string enum: - in_progress - completed - incomplete - calling - failed - type: 'null' title: Status additionalProperties: true type: object required: - id - arguments - name - server_label - type title: McpCall ImageGenerationCall: properties: id: type: string title: Id result: anyOf: - type: string - type: 'null' title: Result status: type: string enum: - in_progress - completed - generating - failed title: Status type: type: string const: image_generation_call title: Type additionalProperties: true type: object required: - id - status - type title: ImageGenerationCall McpRequireApprovalMcpToolApprovalFilterNever: properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only tool_names: anyOf: - items: type: string type: array - type: 'null' title: Tool Names additionalProperties: true type: object title: McpRequireApprovalMcpToolApprovalFilterNever EasyInputMessage: properties: content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' - $ref: '#/components/schemas/ResponseInputAudio' type: array title: Content role: type: string enum: - user - assistant - system - developer title: Role type: anyOf: - type: string const: message - type: 'null' title: Type additionalProperties: true type: object required: - content - role title: EasyInputMessage ActionFind: properties: pattern: type: string title: Pattern type: type: string const: find title: Type url: type: string title: Url additionalProperties: true type: object required: - pattern - type - url title: ActionFind ActionScroll: properties: scroll_x: type: integer title: Scroll X scroll_y: type: integer title: Scroll Y type: type: string const: scroll title: Type x: type: integer title: X y: type: integer title: Y additionalProperties: true type: object required: - scroll_x - scroll_y - type - x - y title: ActionScroll ResponseCustomToolCall: properties: call_id: type: string title: Call Id input: type: string title: Input name: type: string title: Name type: type: string const: custom_tool_call title: Type id: anyOf: - type: string - type: 'null' title: Id additionalProperties: true type: object required: - call_id - input - name - type title: ResponseCustomToolCall ResponseFunctionToolCall: properties: arguments: type: string title: Arguments call_id: type: string title: Call Id name: type: string title: Name type: type: string const: function_call title: Type id: anyOf: - type: string - type: 'null' title: Id status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - arguments - call_id - name - type title: ResponseFunctionToolCall ActionClick: properties: button: type: string enum: - left - right - wheel - back - forward title: Button type: type: string const: click title: Type x: type: integer title: X y: type: integer title: Y additionalProperties: true type: object required: - button - type - x - y title: ActionClick McpRequireApprovalMcpToolApprovalFilter: properties: always: anyOf: - $ref: '#/components/schemas/McpRequireApprovalMcpToolApprovalFilterAlways' - type: 'null' never: anyOf: - $ref: '#/components/schemas/McpRequireApprovalMcpToolApprovalFilterNever' - type: 'null' additionalProperties: true type: object title: McpRequireApprovalMcpToolApprovalFilter ResponseUsage: properties: input_tokens: type: integer title: Input Tokens input_tokens_details: $ref: '#/components/schemas/InputTokensDetails' output_tokens: type: integer title: Output Tokens output_tokens_details: $ref: '#/components/schemas/OutputTokensDetails' total_tokens: type: integer title: Total Tokens additionalProperties: true type: object required: - input_tokens - input_tokens_details - output_tokens - output_tokens_details - total_tokens title: ResponseUsage ComparisonFilter: properties: key: type: string title: Key type: type: string enum: - eq - ne - gt - gte - lt - lte title: Type value: anyOf: - type: string - type: number - type: boolean title: Value additionalProperties: true type: object required: - key - type - value title: ComparisonFilter ResponseCodeInterpreterToolCall: properties: id: type: string title: Id code: anyOf: - type: string - type: 'null' title: Code container_id: type: string title: Container Id outputs: anyOf: - items: anyOf: - $ref: '#/components/schemas/OutputLogs' - $ref: '#/components/schemas/OutputImage' type: array - type: 'null' title: Outputs status: type: string enum: - in_progress - completed - incomplete - interpreting - failed title: Status type: type: string const: code_interpreter_call title: Type additionalProperties: true type: object required: - id - container_id - status - type title: ResponseCodeInterpreterToolCall ResponseFunctionWebSearch: properties: id: type: string title: Id action: anyOf: - $ref: '#/components/schemas/ActionSearch' - $ref: '#/components/schemas/ActionOpenPage' - $ref: '#/components/schemas/ActionFind' title: Action status: type: string enum: - in_progress - searching - completed - failed title: Status type: type: string const: web_search_call title: Type additionalProperties: true type: object required: - id - action - status - type title: ResponseFunctionWebSearch ResponsesRequest: properties: model: type: string minLength: 1 title: Model description: The name of the model to use (key in model configurations). input: title: Input description: Required. Input to the responses endpoint. This is forwarded to the backend and may be a string or a structured content array, depending on model support. store: type: boolean title: Store description: Whether to store the response. default: false file_id: anyOf: - type: string - type: 'null' title: File Id description: Optional. Id returned by POST /v1/files (data layer). The gateway fetches the file metadata/content from the data layer and forwards a file object to vLLM. temperature: anyOf: - type: number maximum: 2.0 minimum: 0.0 - type: 'null' title: Temperature description: Sampling temperature (0–2, same range as chat completions). max_output_tokens: anyOf: - type: integer maximum: 150000.0 minimum: 1.0 - type: 'null' title: Max Output Tokens description: Upper bound on output tokens (same bounds as chat max_completion_tokens). additionalProperties: true type: object required: - model - input title: ResponsesRequest description: 'Request body for the responses endpoint (/v1/responses). Required: model, input. Optional: store, temperature, max_output_tokens. Additional fields (e.g. text, reasoning, metadata, tools) are forwarded to the backend.' examples: - input: Say hello in one short sentence. model: cai-llama-3-1-8b-slim reasoning: {} store: false text: format: type: text CompoundFilter: properties: filters: items: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - {} type: array title: Filters type: type: string enum: - and - or title: Type additionalProperties: true type: object required: - filters - type title: CompoundFilter ResponseComputerToolCall: properties: id: type: string title: Id action: anyOf: - $ref: '#/components/schemas/ActionClick' - $ref: '#/components/schemas/ActionDoubleClick' - $ref: '#/components/schemas/ActionDrag' - $ref: '#/components/schemas/ActionKeypress' - $ref: '#/components/schemas/ActionMove' - $ref: '#/components/schemas/ActionScreenshot' - $ref: '#/components/schemas/ActionScroll' - $ref: '#/components/schemas/ActionType' - $ref: '#/components/schemas/ActionWait' title: Action call_id: type: string title: Call Id pending_safety_checks: items: $ref: '#/components/schemas/PendingSafetyCheck' type: array title: Pending Safety Checks status: type: string enum: - in_progress - completed - incomplete title: Status type: type: string const: computer_call title: Type additionalProperties: true type: object required: - id - action - call_id - pending_safety_checks - status - type title: ResponseComputerToolCall ImageGenerationInputImageMask: properties: file_id: anyOf: - type: string - type: 'null' title: File Id image_url: anyOf: - type: string - type: 'null' title: Image Url additionalProperties: true type: object title: ImageGenerationInputImageMask ComputerTool: properties: display_height: type: integer title: Display Height display_width: type: integer title: Display Width environment: type: string enum: - windows - mac - linux - ubuntu - browser title: Environment type: type: string const: computer_use_preview title: Type additionalProperties: true type: object required: - display_height - display_width - environment - type title: ComputerTool InputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens additionalProperties: true type: object required: - cached_tokens title: InputTokensDetails Content: properties: text: type: string title: Text type: type: string const: reasoning_text title: Type additionalProperties: true type: object required: - text - type title: Content ToolChoiceTypes: properties: type: type: string enum: - file_search - web_search_preview - computer_use_preview - web_search_preview_2025_03_11 - image_generation - code_interpreter title: Type additionalProperties: true type: object required: - type title: ToolChoiceTypes FunctionTool-Output: properties: name: type: string title: Name parameters: anyOf: - additionalProperties: true type: object - type: 'null' title: Parameters strict: anyOf: - type: boolean - type: 'null' title: Strict type: type: string const: function title: Type description: anyOf: - type: string - type: 'null' title: Description additionalProperties: true type: object required: - name - type title: FunctionTool ResponseComputerToolCallOutputScreenshot: properties: type: type: string const: computer_screenshot title: Type file_id: anyOf: - type: string - type: 'null' title: File Id image_url: anyOf: - type: string - type: 'null' title: Image Url additionalProperties: true type: object required: - type title: ResponseComputerToolCallOutputScreenshot Summary: properties: text: type: string title: Text type: type: string const: summary_text title: Type additionalProperties: true type: object required: - text - type title: Summary ResponseTextConfig: properties: format: anyOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig' - $ref: '#/components/schemas/ResponseFormatJSONObject' - type: 'null' title: Format verbosity: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Verbosity additionalProperties: true type: object title: ResponseTextConfig McpListToolsTool: properties: input_schema: title: Input Schema name: type: string title: Name annotations: anyOf: - {} - type: 'null' title: Annotations description: anyOf: - type: string - type: 'null' title: Description additionalProperties: true type: object required: - input_schema - name title: McpListToolsTool McpRequireApprovalMcpToolApprovalFilterAlways: properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only tool_names: anyOf: - items: type: string type: array - type: 'null' title: Tool Names additionalProperties: true type: object title: McpRequireApprovalMcpToolApprovalFilterAlways ResponseOutputRefusal: properties: refusal: type: string title: Refusal type: type: string const: refusal title: Type additionalProperties: true type: object required: - refusal - type title: ResponseOutputRefusal LocalShellCall: properties: id: type: string title: Id action: $ref: '#/components/schemas/LocalShellCallAction' call_id: type: string title: Call Id status: type: string enum: - in_progress - completed - incomplete title: Status type: type: string const: local_shell_call title: Type additionalProperties: true type: object required: - id - action - call_id - status - type title: LocalShellCall FunctionCallOutput: properties: call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputTextContent' - $ref: '#/components/schemas/ResponseInputImageContent' - $ref: '#/components/schemas/ResponseInputFileContent' type: array title: Output type: type: string const: function_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - call_id - output - type title: FunctionCallOutput ResponseInputFile: properties: type: type: string const: input_file title: Type file_data: anyOf: - type: string - type: 'null' title: File Data file_id: anyOf: - type: string - type: 'null' title: File Id file_url: anyOf: - type: string - type: 'null' title: File Url filename: anyOf: - type: string - type: 'null' title: Filename additionalProperties: true type: object required: - type title: ResponseInputFile ToolChoiceAllowed: properties: mode: type: string enum: - auto - required title: Mode tools: items: additionalProperties: true type: object type: array title: Tools type: type: string const: allowed_tools title: Type additionalProperties: true type: object required: - mode - tools - type title: ToolChoiceAllowed OutputLogs: properties: logs: type: string title: Logs type: type: string const: logs title: Type additionalProperties: true type: object required: - logs - type title: OutputLogs ResponseFormatTextJSONSchemaConfig: properties: name: type: string title: Name schema: additionalProperties: true type: object title: Schema type: type: string const: json_schema title: Type description: anyOf: - type: string - type: 'null' title: Description strict: anyOf: - type: boolean - type: 'null' title: Strict additionalProperties: true type: object required: - name - schema - type title: ResponseFormatTextJSONSchemaConfig LogprobTopLogprob: properties: token: type: string title: Token bytes: items: type: integer type: array title: Bytes logprob: type: number title: Logprob additionalProperties: true type: object required: - token - bytes - logprob title: LogprobTopLogprob ActionSearch: properties: query: type: string title: Query type: type: string const: search title: Type sources: anyOf: - items: $ref: '#/components/schemas/ActionSearchSource' type: array - type: 'null' title: Sources additionalProperties: true type: object required: - query - type title: ActionSearch OutputImage: properties: type: type: string const: image title: Type url: type: string title: Url additionalProperties: true type: object required: - type - url title: OutputImage ComputerCallOutputAcknowledgedSafetyCheck: properties: id: type: string title: Id code: anyOf: - type: string - type: 'null' title: Code message: anyOf: - type: string - type: 'null' title: Message additionalProperties: true type: object required: - id title: ComputerCallOutputAcknowledgedSafetyCheck ActionWait: properties: type: type: string const: wait title: Type additionalProperties: true type: object required: - type title: ActionWait IncompleteDetails: properties: reason: anyOf: - type: string enum: - max_output_tokens - content_filter - type: 'null' title: Reason additionalProperties: true type: object title: IncompleteDetails CustomTool: properties: name: type: string title: Name type: type: string const: custom title: Type description: anyOf: - type: string - type: 'null' title: Description format: anyOf: - $ref: '#/components/schemas/Text' - $ref: '#/components/schemas/Grammar' - type: 'null' title: Format additionalProperties: true type: object required: - name - type title: CustomTool ActionMove: properties: type: type: string const: move title: Type x: type: integer title: X y: type: integer title: Y additionalProperties: true type: object required: - type - x - y title: ActionMove AnnotationFilePath: properties: file_id: type: string title: File Id index: type: integer title: Index type: type: string const: file_path title: Type additionalProperties: true type: object required: - file_id - index - type title: AnnotationFilePath Filters: properties: allowed_domains: anyOf: - items: type: string type: array - type: 'null' title: Allowed Domains additionalProperties: true type: object title: Filters ResponseOutputText: properties: annotations: items: anyOf: - $ref: '#/components/schemas/AnnotationFileCitation' - $ref: '#/components/schemas/AnnotationURLCitation' - $ref: '#/components/schemas/AnnotationContainerFileCitation' - $ref: '#/components/schemas/AnnotationFilePath' type: array title: Annotations text: type: string title: Text type: type: string const: output_text title: Type logprobs: anyOf: - items: $ref: '#/components/schemas/Logprob' type: array - type: 'null' title: Logprobs additionalProperties: true type: object required: - annotations - text - type title: ResponseOutputText Mcp: properties: server_label: type: string title: Server Label type: type: string const: mcp title: Type allowed_tools: anyOf: - items: type: string type: array - $ref: '#/components/schemas/McpAllowedToolsMcpToolFilter' - type: 'null' title: Allowed Tools authorization: anyOf: - type: string - type: 'null' title: Authorization connector_id: anyOf: - type: string enum: - connector_dropbox - connector_gmail - connector_googlecalendar - connector_googledrive - connector_microsoftteams - connector_outlookcalendar - connector_outlookemail - connector_sharepoint - type: 'null' title: Connector Id headers: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Headers require_approval: anyOf: - $ref: '#/components/schemas/McpRequireApprovalMcpToolApprovalFilter' - type: string enum: - always - never - type: 'null' title: Require Approval server_description: anyOf: - type: string - type: 'null' title: Server Description server_url: anyOf: - type: string - type: 'null' title: Server Url additionalProperties: true type: object required: - server_label - type title: Mcp McpApprovalResponse: properties: approval_request_id: type: string title: Approval Request Id approve: type: boolean title: Approve type: type: string const: mcp_approval_response title: Type id: anyOf: - type: string - type: 'null' title: Id reason: anyOf: - type: string - type: 'null' title: Reason additionalProperties: true type: object required: - approval_request_id - approve - type title: McpApprovalResponse McpAllowedToolsMcpToolFilter: properties: read_only: anyOf: - type: boolean - type: 'null' title: Read Only tool_names: anyOf: - items: type: string type: array - type: 'null' title: Tool Names additionalProperties: true type: object title: McpAllowedToolsMcpToolFilter ResponsesResult: properties: id: type: string title: Id created_at: type: integer title: Created At description: Unix timestamp (seconds) when the response was created. error: anyOf: - $ref: '#/components/schemas/ResponseError' - type: 'null' incomplete_details: anyOf: - $ref: '#/components/schemas/IncompleteDetails' - type: 'null' instructions: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/EasyInputMessage' - $ref: '#/components/schemas/Message' - $ref: '#/components/schemas/ResponseOutputMessage' - $ref: '#/components/schemas/ResponseFileSearchToolCall' - $ref: '#/components/schemas/ResponseComputerToolCall' - $ref: '#/components/schemas/ComputerCallOutput' - $ref: '#/components/schemas/ResponseFunctionWebSearch' - $ref: '#/components/schemas/ResponseFunctionToolCall' - $ref: '#/components/schemas/FunctionCallOutput' - $ref: '#/components/schemas/ResponseReasoningItem' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/LocalShellCallOutput' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: '#/components/schemas/McpApprovalResponse' - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/ResponseCustomToolCallOutput' - $ref: '#/components/schemas/ResponseCustomToolCall' - $ref: '#/components/schemas/ItemReference' type: array - type: 'null' title: Instructions metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata model: anyOf: - type: string - type: string enum: - gpt-5 - gpt-5-mini - gpt-5-nano - gpt-5-2025-08-07 - gpt-5-mini-2025-08-07 - gpt-5-nano-2025-08-07 - gpt-5-chat-latest - gpt-4.1 - gpt-4.1-mini - gpt-4.1-nano - gpt-4.1-2025-04-14 - gpt-4.1-mini-2025-04-14 - gpt-4.1-nano-2025-04-14 - o4-mini - o4-mini-2025-04-16 - o3 - o3-2025-04-16 - o3-mini - o3-mini-2025-01-31 - o1 - o1-2024-12-17 - o1-preview - o1-preview-2024-09-12 - o1-mini - o1-mini-2024-09-12 - gpt-4o - gpt-4o-2024-11-20 - gpt-4o-2024-08-06 - gpt-4o-2024-05-13 - gpt-4o-audio-preview - gpt-4o-audio-preview-2024-10-01 - gpt-4o-audio-preview-2024-12-17 - gpt-4o-audio-preview-2025-06-03 - gpt-4o-mini-audio-preview - gpt-4o-mini-audio-preview-2024-12-17 - gpt-4o-search-preview - gpt-4o-mini-search-preview - gpt-4o-search-preview-2025-03-11 - gpt-4o-mini-search-preview-2025-03-11 - chatgpt-4o-latest - codex-mini-latest - gpt-4o-mini - gpt-4o-mini-2024-07-18 - gpt-4-turbo - gpt-4-turbo-2024-04-09 - gpt-4-0125-preview - gpt-4-turbo-preview - gpt-4-1106-preview - gpt-4-vision-preview - gpt-4 - gpt-4-0314 - gpt-4-0613 - gpt-4-32k - gpt-4-32k-0314 - gpt-4-32k-0613 - gpt-3.5-turbo - gpt-3.5-turbo-16k - gpt-3.5-turbo-0301 - gpt-3.5-turbo-0613 - gpt-3.5-turbo-1106 - gpt-3.5-turbo-0125 - gpt-3.5-turbo-16k-0613 - type: string enum: - o1-pro - o1-pro-2025-03-19 - o3-pro - o3-pro-2025-06-10 - o3-deep-research - o3-deep-research-2025-06-26 - o4-mini-deep-research - o4-mini-deep-research-2025-06-26 - computer-use-preview - computer-use-preview-2025-03-11 - gpt-5-codex title: Model object: type: string const: response title: Object output: items: anyOf: - $ref: '#/components/schemas/ResponseOutputMessage' - $ref: '#/components/schemas/ResponseFileSearchToolCall' - $ref: '#/components/schemas/ResponseFunctionToolCall' - $ref: '#/components/schemas/ResponseFunctionWebSearch' - $ref: '#/components/schemas/ResponseComputerToolCall' - $ref: '#/components/schemas/ResponseReasoningItem' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: '#/components/schemas/ResponseCustomToolCall' type: array title: Output parallel_tool_calls: type: boolean title: Parallel Tool Calls temperature: anyOf: - type: number - type: 'null' title: Temperature tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction-Output' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' title: Tool Choice tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool-Output' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/WebSearchPreviewTool' type: array title: Tools top_p: anyOf: - type: number - type: 'null' title: Top P background: anyOf: - type: boolean - type: 'null' title: Background conversation: anyOf: - $ref: '#/components/schemas/Conversation' - type: 'null' max_output_tokens: anyOf: - type: integer - type: 'null' title: Max Output Tokens max_tool_calls: anyOf: - type: integer - type: 'null' title: Max Tool Calls previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id prompt: anyOf: - $ref: '#/components/schemas/ResponsePrompt' - type: 'null' prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' safety_identifier: anyOf: - type: string - type: 'null' title: Safety Identifier service_tier: anyOf: - type: string enum: - auto - default - flex - scale - priority - type: 'null' title: Service Tier status: anyOf: - type: string enum: - completed - failed - in_progress - cancelled - queued - incomplete - type: 'null' title: Status text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' top_logprobs: anyOf: - type: integer - type: 'null' title: Top Logprobs truncation: anyOf: - type: string enum: - auto - disabled - type: 'null' title: Truncation usage: anyOf: - $ref: '#/components/schemas/ResponseUsage' - type: 'null' user: anyOf: - type: string - type: 'null' title: User completed_at: anyOf: - type: integer - type: 'null' title: Completed At description: Unix timestamp when the response was completed (set by vllm). additionalProperties: true type: object required: - id - created_at - model - object - output - parallel_tool_calls - tool_choice - tools title: ResponsesResult description: 'Result from the responses endpoint (/v1/responses). Inherits OpenAI''s response schema and includes ``completed_at`` set by this endpoint after the upstream response is received.' examples: - completed_at: 1773872348 created_at: 1773872348 id: resp_123 model: MultiverseComputingCAI/Hypernova-60B-2602 object: response output: - content: - text: Hello! type: output_text role: assistant type: message status: completed usage: input_tokens: 12 output_tokens: 3 total_tokens: 15 ToolChoiceCustom: properties: name: type: string title: Name type: type: string const: custom title: Type additionalProperties: true type: object required: - name - type title: ToolChoiceCustom ResponseCustomToolCallOutput: properties: call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: array title: Output type: type: string const: custom_tool_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id additionalProperties: true type: object required: - call_id - output - type title: ResponseCustomToolCallOutput Grammar: properties: definition: type: string title: Definition syntax: type: string enum: - lark - regex title: Syntax type: type: string const: grammar title: Type additionalProperties: true type: object required: - definition - syntax - type title: Grammar WebSearchTool: properties: type: type: string enum: - web_search - web_search_2025_08_26 title: Type filters: anyOf: - $ref: '#/components/schemas/Filters' - type: 'null' search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Search Context Size user_location: anyOf: - $ref: '#/components/schemas/openai__types__responses__web_search_tool__UserLocation' - type: 'null' additionalProperties: true type: object required: - type title: WebSearchTool ResponseInputFileContent: properties: type: type: string const: input_file title: Type file_data: anyOf: - type: string - type: 'null' title: File Data file_id: anyOf: - type: string - type: 'null' title: File Id file_url: anyOf: - type: string - type: 'null' title: File Url filename: anyOf: - type: string - type: 'null' title: Filename additionalProperties: true type: object required: - type title: ResponseInputFileContent ResponseInputTextContent: properties: text: type: string title: Text type: type: string const: input_text title: Type additionalProperties: true type: object required: - text - type title: ResponseInputTextContent ActionDragPath: properties: x: type: integer title: X y: type: integer title: Y additionalProperties: true type: object required: - x - y title: ActionDragPath ResponsePrompt: properties: id: type: string title: Id variables: anyOf: - additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: object - type: 'null' title: Variables version: anyOf: - type: string - type: 'null' title: Version additionalProperties: true type: object required: - id title: ResponsePrompt Logprob: properties: token: type: string title: Token bytes: items: type: integer type: array title: Bytes logprob: type: number title: Logprob top_logprobs: items: $ref: '#/components/schemas/LogprobTopLogprob' type: array title: Top Logprobs additionalProperties: true type: object required: - token - bytes - logprob - top_logprobs title: Logprob ResponseInputText: properties: text: type: string title: Text type: type: string const: input_text title: Type additionalProperties: true type: object required: - text - type title: ResponseInputText ItemReference: properties: id: type: string title: Id type: anyOf: - type: string const: item_reference - type: 'null' title: Type additionalProperties: true type: object required: - id title: ItemReference WebSearchPreviewTool: properties: type: type: string enum: - web_search_preview - web_search_preview_2025_03_11 title: Type search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Search Context Size user_location: anyOf: - $ref: '#/components/schemas/openai__types__responses__web_search_preview_tool__UserLocation' - type: 'null' additionalProperties: true type: object required: - type title: WebSearchPreviewTool McpListTools: properties: id: type: string title: Id server_label: type: string title: Server Label tools: items: $ref: '#/components/schemas/McpListToolsTool' type: array title: Tools type: type: string const: mcp_list_tools title: Type error: anyOf: - type: string - type: 'null' title: Error additionalProperties: true type: object required: - id - server_label - tools - type title: McpListTools ResponseError: properties: code: type: string enum: - server_error - rate_limit_exceeded - invalid_prompt - vector_store_timeout - invalid_image - invalid_image_format - invalid_base64_image - invalid_image_url - image_too_large - image_too_small - image_parse_error - image_content_policy_violation - invalid_image_mode - image_file_too_large - unsupported_image_media_type - empty_image_file - failed_to_download_image - image_file_not_found title: Code message: type: string title: Message additionalProperties: true type: object required: - code - message title: ResponseError Conversation: properties: id: type: string title: Id additionalProperties: true type: object required: - id title: Conversation ToolChoiceFunction-Output: properties: name: type: string title: Name type: type: string const: function title: Type additionalProperties: true type: object required: - name - type title: ToolChoiceFunction Text: properties: type: type: string const: text title: Type additionalProperties: true type: object required: - type title: Text ActionType: properties: text: type: string title: Text type: type: string const: type title: Type additionalProperties: true type: object required: - text - type title: ActionType openai__types__responses__web_search_preview_tool__UserLocation: properties: type: type: string const: approximate title: Type city: anyOf: - type: string - type: 'null' title: City country: anyOf: - type: string - type: 'null' title: Country region: anyOf: - type: string - type: 'null' title: Region timezone: anyOf: - type: string - type: 'null' title: Timezone additionalProperties: true type: object required: - type title: UserLocation AnnotationFileCitation: properties: file_id: type: string title: File Id filename: type: string title: Filename index: type: integer title: Index type: type: string const: file_citation title: Type additionalProperties: true type: object required: - file_id - filename - index - type title: AnnotationFileCitation ActionKeypress: properties: keys: items: type: string type: array title: Keys type: type: string const: keypress title: Type additionalProperties: true type: object required: - keys - type title: ActionKeypress CodeInterpreter: properties: container: anyOf: - type: string - $ref: '#/components/schemas/CodeInterpreterContainerCodeInterpreterToolAuto' title: Container type: type: string const: code_interpreter title: Type additionalProperties: true type: object required: - container - type title: CodeInterpreter ComputerCallOutput: properties: call_id: type: string title: Call Id output: $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot' type: type: string const: computer_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id acknowledged_safety_checks: anyOf: - items: $ref: '#/components/schemas/ComputerCallOutputAcknowledgedSafetyCheck' type: array - type: 'null' title: Acknowledged Safety Checks status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - call_id - output - type title: ComputerCallOutput ImageGeneration: properties: type: type: string const: image_generation title: Type background: anyOf: - type: string enum: - transparent - opaque - auto - type: 'null' title: Background input_fidelity: anyOf: - type: string enum: - high - low - type: 'null' title: Input Fidelity input_image_mask: anyOf: - $ref: '#/components/schemas/ImageGenerationInputImageMask' - type: 'null' model: anyOf: - type: string const: gpt-image-1 - type: 'null' title: Model moderation: anyOf: - type: string enum: - auto - low - type: 'null' title: Moderation output_compression: anyOf: - type: integer - type: 'null' title: Output Compression output_format: anyOf: - type: string enum: - png - webp - jpeg - type: 'null' title: Output Format partial_images: anyOf: - type: integer - type: 'null' title: Partial Images quality: anyOf: - type: string enum: - low - medium - high - auto - type: 'null' title: Quality size: anyOf: - type: string enum: - 1024x1024 - 1024x1536 - 1536x1024 - auto - type: 'null' title: Size additionalProperties: true type: object required: - type title: ImageGeneration ResponseFileSearchToolCall: properties: id: type: string title: Id queries: items: type: string type: array title: Queries status: type: string enum: - in_progress - searching - completed - incomplete - failed title: Status type: type: string const: file_search_call title: Type results: anyOf: - items: $ref: '#/components/schemas/Result' type: array - type: 'null' title: Results additionalProperties: true type: object required: - id - queries - status - type title: ResponseFileSearchToolCall ActionDrag: properties: path: items: $ref: '#/components/schemas/ActionDragPath' type: array title: Path type: type: string const: drag title: Type additionalProperties: true type: object required: - path - type title: ActionDrag AnnotationContainerFileCitation: properties: container_id: type: string title: Container Id end_index: type: integer title: End Index file_id: type: string title: File Id filename: type: string title: Filename start_index: type: integer title: Start Index type: type: string const: container_file_citation title: Type additionalProperties: true type: object required: - container_id - end_index - file_id - filename - start_index - type title: AnnotationContainerFileCitation ActionOpenPage: properties: type: type: string const: open_page title: Type url: type: string title: Url additionalProperties: true type: object required: - type - url title: ActionOpenPage ActionSearchSource: properties: type: type: string const: url title: Type url: type: string title: Url additionalProperties: true type: object required: - type - url title: ActionSearchSource InputAudio-Output: properties: data: type: string title: Data format: type: string enum: - mp3 - wav title: Format additionalProperties: true type: object required: - data - format title: InputAudio ResponseReasoningItem: properties: id: type: string title: Id summary: items: $ref: '#/components/schemas/Summary' type: array title: Summary type: type: string const: reasoning title: Type content: anyOf: - items: $ref: '#/components/schemas/Content' type: array - type: 'null' title: Content encrypted_content: anyOf: - type: string - type: 'null' title: Encrypted Content status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - id - summary - type title: ResponseReasoningItem ToolChoiceMcp: properties: server_label: type: string title: Server Label type: type: string const: mcp title: Type name: anyOf: - type: string - type: 'null' title: Name additionalProperties: true type: object required: - server_label - type title: ToolChoiceMcp Result: properties: attributes: anyOf: - additionalProperties: anyOf: - type: string - type: number - type: boolean type: object - type: 'null' title: Attributes file_id: anyOf: - type: string - type: 'null' title: File Id filename: anyOf: - type: string - type: 'null' title: Filename score: anyOf: - type: number - type: 'null' title: Score text: anyOf: - type: string - type: 'null' title: Text additionalProperties: true type: object title: Result ResponseOutputMessage: properties: id: type: string title: Id content: items: anyOf: - $ref: '#/components/schemas/ResponseOutputText' - $ref: '#/components/schemas/ResponseOutputRefusal' type: array title: Content role: type: string const: assistant title: Role status: type: string enum: - in_progress - completed - incomplete title: Status type: type: string const: message title: Type additionalProperties: true type: object required: - id - content - role - status - type title: ResponseOutputMessage ResponseInputAudio: properties: input_audio: $ref: '#/components/schemas/InputAudio-Output' type: type: string const: input_audio title: Type additionalProperties: true type: object required: - input_audio - type title: ResponseInputAudio OutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens additionalProperties: true type: object required: - reasoning_tokens title: OutputTokensDetails openai__types__responses__web_search_tool__UserLocation: properties: city: anyOf: - type: string - type: 'null' title: City country: anyOf: - type: string - type: 'null' title: Country region: anyOf: - type: string - type: 'null' title: Region timezone: anyOf: - type: string - type: 'null' title: Timezone type: anyOf: - type: string const: approximate - type: 'null' title: Type additionalProperties: true type: object title: UserLocation ResponseInputImage: properties: detail: type: string enum: - low - high - auto title: Detail type: type: string const: input_image title: Type file_id: anyOf: - type: string - type: 'null' title: File Id image_url: anyOf: - type: string - type: 'null' title: Image Url additionalProperties: true type: object required: - detail - type title: ResponseInputImage AnnotationURLCitation: properties: end_index: type: integer title: End Index start_index: type: integer title: Start Index title: type: string title: Title type: type: string const: url_citation title: Type url: type: string title: Url additionalProperties: true type: object required: - end_index - start_index - title - type - url title: AnnotationURLCitation ActionDoubleClick: properties: type: type: string const: double_click title: Type x: type: integer title: X y: type: integer title: Y additionalProperties: true type: object required: - type - x - y title: ActionDoubleClick LocalShell: properties: type: type: string const: local_shell title: Type additionalProperties: true type: object required: - type title: LocalShell securitySchemes: HTTPBearer: type: http scheme: bearer