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

# Responses

> OpenAI Responses–compatible endpoint on the Modellix LLM gateway. Accepts a synchronous request with `model` (provider/name format) and `input` (string or content array); returns a Responses JSON object by default, or SSE (`text/event-stream`) when `stream=true`. Use `max_output_tokens` for output limits. Prefer this path when the client targets the OpenAI Responses API rather than classic Chat Completions. Do not send Chat Completions-style `messages`/`max_tokens` or Anthropic Messages shapes on this endpoint—use `/chat/completions` or `/messages` instead. Optional fields follow [OpenAI Responses](https://platform.openai.com/docs/api-reference/responses); support depends on the selected model.



## OpenAPI

````yaml /llm/llm.json post /responses
openapi: 3.1.0
info:
  title: Modellix LLM API
  description: >-
    Public API of the Modellix LLM Gateway (llm-bff): OpenAI-compatible Chat
    Completions and Responses, plus Anthropic-compatible Messages.


    Optional fields follow the corresponding official protocols; this document
    lists commonly used core fields only. See `docs/api/llm.md` for the
    human-readable guide.
  version: '2026-08-04'
  contact:
    name: Modellix
servers:
  - url: https://llm.modellix.ai/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
tags:
  - name: Chat Completions
    description: OpenAI-compatible Chat Completions
  - name: Responses
    description: OpenAI-compatible Responses
  - name: Messages
    description: Anthropic-compatible Messages
paths:
  /responses:
    post:
      tags:
        - Responses
      summary: Responses
      description: >-
        OpenAI Responses–compatible endpoint on the Modellix LLM gateway.
        Accepts a synchronous request with `model` (provider/name format) and
        `input` (string or content array); returns a Responses JSON object by
        default, or SSE (`text/event-stream`) when `stream=true`. Use
        `max_output_tokens` for output limits. Prefer this path when the client
        targets the OpenAI Responses API rather than classic Chat Completions.
        Do not send Chat Completions-style `messages`/`max_tokens` or Anthropic
        Messages shapes on this endpoint—use `/chat/completions` or `/messages`
        instead. Optional fields follow [OpenAI
        Responses](https://platform.openai.com/docs/api-reference/responses);
        support depends on the selected model.
      operationId: createResponse
      parameters:
        - $ref: '#/components/parameters/SessionIdHeader'
      requestBody:
        required: true
        description: >-
          OpenAI Responses request body. Requires model and input; optional
          stream, max_output_tokens, and temperature. Do not send Chat
          Completions messages.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponsesRequest'
            example:
              model: openai/gpt-5.6-luna
              stream: false
              max_output_tokens: 256
              input: Introduce yourself in one sentence
      responses:
        '200':
          description: Success. Non-streaming returns JSON; streaming returns SSE.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesResponse'
            text/event-stream:
              schema:
                type: string
                description: 'SSE: OpenAI Responses event stream'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        5XX:
          $ref: '#/components/responses/UpstreamError'
components:
  parameters:
    SessionIdHeader:
      name: X-Mdlx-Session-Id
      in: header
      required: false
      description: >-
        Optional session affinity header. Length 8–128; alphanumeric, `-`, and
        `_` only.
      schema:
        type: string
        minLength: 8
        maxLength: 128
        pattern: ^[A-Za-z0-9_-]+$
        example: my-conversation-001
  schemas:
    ResponsesRequest:
      type: object
      required:
        - model
        - input
      additionalProperties: true
      description: Core fields below; other fields follow OpenAI Responses.
      properties:
        model:
          $ref: '#/components/schemas/ModelId'
        input:
          description: >-
            String or content array for the Responses API. Not a Chat
            Completions messages array.
          oneOf:
            - type: string
            - type: array
              items: {}
              description: OpenAI Responses content array items
        stream:
          type: boolean
          default: false
          description: >-
            Default false. When true, returns an OpenAI Responses SSE event
            stream.
        max_output_tokens:
          type: integer
          minimum: 1
          description: >-
            Optional maximum output tokens for the Responses API. Not
            max_tokens.
        temperature:
          type: number
          description: Sampling temperature for the Responses API. Model-dependent.
    ResponsesResponse:
      type: object
      additionalProperties: true
      description: Shape follows OpenAI response
      properties:
        id:
          type: string
          description: Unique identifier for this Responses API result.
        object:
          type: string
          example: response
          description: Object type. Typically response for the Responses API.
        status:
          type: string
          description: Status of the response (for example completed or failed).
        model:
          type: string
          description: Model ID that produced this Responses API result.
        output:
          type: array
          description: Array of response output items (OpenAI Responses shape).
          items:
            type: object
            additionalProperties: true
            description: A single OpenAI Responses output item.
        usage:
          type: object
          additionalProperties: true
          description: >-
            Token usage object for the Responses API. Shape follows OpenAI
            Responses usage, not Chat Completions prompt_tokens fields.
    ModelId:
      type: string
      description: Model ID in `provider/name` form
      examples:
        - openai/gpt-5.5
        - openai/gpt-5.6-sol
        - anthropic/claude-sonnet-5
        - google/gemini-3.6-flash
    ErrorBody:
      type: object
      required:
        - error
      description: >-
        Gateway error envelope shared by Chat Completions, Responses, and
        Messages.
      properties:
        error:
          type: object
          required:
            - message
            - type
          additionalProperties: true
          description: Error details object.
          properties:
            message:
              type: string
              description: Human-readable error message.
            type:
              type: string
              description: >-
                Error type string (for example invalid_request_error,
                rate_limit_exceeded, insufficient_quota).
              examples:
                - invalid_request_error
                - api_error
                - rate_limit_exceeded
                - request_limited
                - insufficient_quota
            code:
              type:
                - string
                - 'null'
              description: Optional machine-readable error code, or null.
            param:
              type:
                - string
                - 'null'
              description: Optional parameter name related to the error, or null.
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    Unauthorized:
      description: >-
        Missing or invalid API key, or conflicting Authorization and x-api-key
        values
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            error:
              message: invalid API key
              type: invalid_request_error
    PaymentRequired:
      description: Insufficient account balance
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          example:
            error:
              message: insufficient balance, please recharge your account
              type: insufficient_quota
    NotFound:
      description: Unknown path, or the selected model is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          examples:
            modelUnavailable:
              summary: Model unavailable
              value:
                error:
                  message: the selected model is unavailable
                  type: invalid_request_error
    RateLimited:
      description: >-
        Rate limited (RPM or other request limits), or the selected model is
        temporarily unavailable (e.g. upstream deployment cooldown)
      headers:
        X-RateLimit-Limit:
          description: Maximum number of requests allowed in the current rate-limit window.
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Number of requests remaining in the current rate-limit window.
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp (seconds) when the current rate-limit window resets.
          schema:
            type: integer
        Retry-After:
          schema:
            type: integer
          description: >-
            May be returned when the model is temporarily unavailable; value in
            seconds
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
          examples:
            rpm:
              summary: RPM exceeded
              value:
                error:
                  message: rate limit exceeded
                  type: rate_limit_exceeded
            modelCooldown:
              summary: Model temporarily unavailable
              value:
                error:
                  message: >-
                    the selected model is temporarily unavailable, please retry
                    later or try another model
                  type: api_error
    UpstreamError:
      description: >-
        Temporary service unavailability or upstream error (client-facing
        message may be sanitized)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Authorization: Bearer <Modellix API Key> (OpenAI SDK, Codex, OpenCode,
        etc.)
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        x-api-key: <Modellix API Key> (Anthropic SDK, Claude Code, etc.).
        Equivalent to Bearer; if both are present they must be the same key.

````