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

# Kimi API (All Models) - Responses Full Reference

> Set reasoning effort with reasoning.effort and caching with prompt_cache_options. Search appears as web_search_call output items. For streaming, handle response.completed / response.incomplete / response.failed; hitting the output limit returns incomplete. Multi-turn requests must include the full output history, including reasoning, tool calls, and results.

> [!NOTE]
>
> **BaseURL**: The default BaseURL is `https://direct.evolink.ai`, which has better support for text models and long-lived connections. `https://api.evolink.ai` is the primary endpoint for multimodal services and serves as a fallback address for text models.


## OpenAPI

````yaml en/api-manual/language-series/kimi/responses/responses-reference.json POST /v1/responses
openapi: 3.1.0
info:
  title: Kimi API (All Models) - Responses Full Reference
  version: 1.0.0
  description: >-
    Call Kimi text models through the OpenAI Responses protocol. Use `model` to
    select `kimi-k3.1-pro`, `kimi-k3.1-pro-highspeed`, or `kimi-k3`. All have a
    context window of 1,048,576 tokens and support multi-turn conversations,
    streaming, tool calling, web search, structured output, and image input.


    Reasoning is always enabled for all three models; adjust its intensity with
    `reasoning.effort`. Structured output and cache write TTL vary by model; see
    the `model` field. Preserve complete reasoning and tool-call history in
    multi-turn conversations.
servers:
  - url: https://direct.evolink.ai
    description: Production (Recommended)
  - url: https://api.evolink.ai
    description: Alternative URL
security:
  - bearerAuth: []
paths:
  /v1/responses:
    post:
      tags:
        - Responses
      summary: Kimi Responses API (all models)
      description: >-
        Set reasoning effort with reasoning.effort and caching with
        prompt_cache_options. Search appears as web_search_call output items.
        For streaming, handle response.completed / response.incomplete /
        response.failed; hitting the output limit returns incomplete. Multi-turn
        requests must include the full output history, including reasoning, tool
        calls, and results.
      operationId: createResponseKimi
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponsesRequest'
            examples:
              simple:
                summary: Minimal Pro request
                value:
                  model: kimi-k3.1-pro
                  input: Reply with OK.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
              highspeed:
                summary: Minimal Highspeed request
                value:
                  model: kimi-k3.1-pro-highspeed
                  input: Reply with OK.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
              k3:
                summary: Minimal Kimi K3 request
                value:
                  model: kimi-k3
                  input: Reply with OK.
                  max_output_tokens: 1024
              streaming:
                summary: Responses SSE streaming
                value:
                  model: kimi-k3.1-pro
                  input: Reply with OK.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
                  stream: true
              multimodal:
                summary: Image input
                value:
                  model: kimi-k3.1-pro
                  input:
                    - role: user
                      content:
                        - type: input_image
                          image_url: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA...
                        - type: input_text
                          text: Describe this image.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
              function_calling:
                summary: Function Call
                value:
                  model: kimi-k3.1-pro
                  input: Check today's weather in Beijing.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
                  tools:
                    - type: function
                      name: get_weather
                      description: Get the weather for a specified city
                      parameters:
                        type: object
                        properties:
                          city:
                            type: string
                            description: City name
                        required:
                          - city
              web_search:
                summary: Server-side web search
                value:
                  model: kimi-k3.1-pro
                  input: Use web search to find the official Kimi homepage URL.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
                  tools:
                    - type: web_search
              structured_output:
                summary: Strict JSON Schema (K3.1 series only)
                value:
                  model: kimi-k3.1-pro
                  input: Return a JSON object with result equal to OK.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
                  text:
                    format:
                      type: json_schema
                      name: result
                      strict: true
                      schema:
                        type: object
                        properties:
                          result:
                            type: string
                        required:
                          - result
                        additionalProperties: false
              cache_1h:
                summary: Automatic 1h cache writes (K3.1 series only)
                value:
                  model: kimi-k3.1-pro
                  input: Reply with OK.
                  reasoning:
                    effort: low
                  max_output_tokens: 1024
                  prompt_cache_options:
                    mode: implicit
                    ttl: 1h
      responses:
        '200':
          description: Response created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesResponse'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/ResponsesStreamEvent'
        '400':
          description: Bad request - invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access to this resource is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded or insufficient quota
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ResponsesRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          enum:
            - kimi-k3.1-pro
            - kimi-k3.1-pro-highspeed
            - kimi-k3
          default: kimi-k3.1-pro
          description: >-
            Model to call:


            | Model ID | Positioning | Reasoning effort |

            |---|---|---|

            | `kimi-k3.1-pro` | Latest-generation model (recommended) | `low` /
            `high` / `max`, default `max` |

            | `kimi-k3.1-pro-highspeed` | Same parameters as Pro, faster
            generation | Same as `kimi-k3.1-pro` |

            | `kimi-k3` | Previous-generation model | Only `max` |


            All three models have a context window of 1,048,576 tokens and
            always have reasoning enabled.


            Structured output (`text.format`) and cache write TTL
            (`prompt_cache_options`) are supported only by the K3.1 series, not
            by `kimi-k3`.
        input:
          description: >-
            Request input. A string is equivalent to one user message. An array
            contains typed items in order and may include conversation history,
            tool calls, and tool results.
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ResponsesInputItem'
        instructions:
          type: string
          description: >-
            Top-level system instructions, applied before all other
            instructions.
        stream:
          type: boolean
          default: false
          description: When true, returns the response as an SSE stream.
        max_output_tokens:
          type: integer
          description: >-
            Maximum generated tokens, including reasoning and the final answer.
            Default: 131072; maximum: 1048576, also limited by the remaining
            context.
          minimum: 1
          maximum: 1048576
          default: 131072
        reasoning:
          type: object
          description: Reasoning configuration.
          properties:
            effort:
              type: string
              enum:
                - low
                - high
                - max
                - medium
                - xhigh
                - minimal
                - none
              default: max
              description: >-
                Reasoning effort. Reasoning is always enabled.


                - `kimi-k3.1-pro` / `kimi-k3.1-pro-highspeed`: `low` / `high` /
                `max` are recommended; default `max`. For generic client
                compatibility, `medium` maps to `high`, `xhigh` to `max`, and
                `minimal` / `none` to `low`; `none` does not disable reasoning.

                - `kimi-k3`: only `max` is supported (default).


                Higher effort typically increases reasoning tokens and latency.
                Reasoning tokens count toward output.
        text:
          type: object
          description: Output text configuration.
          properties:
            format:
              type: object
              required:
                - type
                - schema
              description: >-
                Constrain the output structure with JSON Schema. Supported only
                by `kimi-k3.1-pro` / `kimi-k3.1-pro-highspeed`; `kimi-k3` does
                not support it. For structured output with `kimi-k3`, use
                `response_format` in the Chat Completions API.
              properties:
                type:
                  type: string
                  enum:
                    - json_schema
                name:
                  type: string
                  description: Schema name; defaults to `output`.
                schema:
                  type: object
                  description: JSON Schema describing the output structure.
                strict:
                  type: boolean
                  description: Whether to strictly enforce the schema.
        tools:
          type: array
          description: Tools that the model may call.
          items:
            $ref: '#/components/schemas/ResponsesTool'
        tool_choice:
          $ref: '#/components/schemas/ResponsesToolChoice'
        include:
          type: array
          items:
            type: string
            enum:
              - web_search_call.results
              - web_search_call.action.sources
          description: >-
            Additional fields to return, only for `web_search`.
            `web_search_call.action.sources` includes matched web sources;
            `web_search_call.results` includes image search results.
        prompt_cache_options:
          type: object
          description: >-
            Context cache write options, supported only by `kimi-k3.1-pro` /
            `kimi-k3.1-pro-highspeed`; `kimi-k3` does not support this
            parameter. When omitted, a 5m cache is written automatically by
            default. Writes and reads are billed separately.
          properties:
            mode:
              type: string
              enum:
                - implicit
              default: implicit
            ttl:
              type: string
              enum:
                - 5m
                - 1h
              default: 5m
              description: 'Cache TTL: 5m or 1h; default: 5m.'
        temperature:
          type: number
          default: 1
          description: >-
            Sampling temperature, fixed by the model at `1`; omit this field.
            `kimi-k3.1-pro` / `kimi-k3.1-pro-highspeed` automatically ignore it;
            `kimi-k3` returns an error for unsupported values.
        top_p:
          type: number
          default: 0.95
          description: >-
            Nucleus sampling threshold, fixed by the model at `0.95`; omit this
            field. `kimi-k3.1-pro` / `kimi-k3.1-pro-highspeed` automatically
            ignore it; `kimi-k3` returns an error for unsupported values.
    ResponsesResponse:
      type: object
      description: A model response.
      properties:
        id:
          type: string
          description: Unique response identifier.
          example: resp_68f0c1c2d3e4f5a6b7c8d9e0
        object:
          type: string
          enum:
            - response
        created_at:
          type: integer
          description: Unix timestamp when the response was created.
        completed_at:
          type:
            - integer
            - 'null'
          description: >-
            Unix timestamp when the response ended. Present when `status` is
            `completed` or `incomplete`; `null` for `in_progress` or `failed`.
        status:
          type: string
          enum:
            - in_progress
            - completed
            - incomplete
            - failed
          description: >-
            Response status. The initial streaming snapshot has status
            `in_progress`.
        model:
          type: string
          description: Model that generated this response.
        output:
          type: array
          description: >-
            Output item array, ordered as web_search_call (if any), reasoning,
            message, and tool calls.
          items:
            $ref: '#/components/schemas/ResponsesOutputItem'
        usage:
          oneOf:
            - $ref: '#/components/schemas/ResponsesUsage'
            - type: 'null'
        incomplete_details:
          type:
            - object
            - 'null'
          description: Reason provided when `status` is `incomplete`.
          properties:
            reason:
              type: string
              enum:
                - max_output_tokens
                - content_filter
        error:
          type:
            - object
            - 'null'
          description: Error details provided when `status` is `failed`.
          properties:
            code:
              type: string
            message:
              type: string
        instructions:
          type:
            - string
            - 'null'
        reasoning:
          type:
            - object
            - 'null'
        text:
          type:
            - object
            - 'null'
        tools:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/ResponsesTool'
        tool_choice:
          oneOf:
            - $ref: '#/components/schemas/ResponsesToolChoice'
            - type: 'null'
        max_output_tokens:
          type:
            - integer
            - 'null'
        temperature:
          type:
            - number
            - 'null'
        top_p:
          type:
            - number
            - 'null'
        parallel_tool_calls:
          type: boolean
        service_tier:
          type:
            - string
            - 'null'
        store:
          type: boolean
          description: Always `false`.
        background:
          type:
            - boolean
            - 'null'
          description: Always `false`.
        previous_response_id:
          type:
            - string
            - 'null'
          description: Always `null`.
        conversation:
          type:
            - object
            - 'null'
          description: Always `null`.
        prompt_cache_options:
          type: object
          description: >-
            Context cache-write options actually applied by the server. If
            prompt_cache_options was omitted, use the mode and ttl returned
            here.
          properties:
            mode:
              type: string
              enum:
                - implicit
              description: Write mode actually applied.
            ttl:
              type: string
              enum:
                - 5m
                - 1h
              description: Cache TTL actually applied.
    ResponsesStreamEvent:
      type: object
      description: >-
        A single SSE event when `stream: true`. Each frame contains `event:
        <type>` and `data: <json>`; the remaining event-body fields depend on
        `type`.
      required:
        - type
        - sequence_number
      properties:
        type:
          type: string
          enum:
            - response.created
            - response.in_progress
            - response.output_item.added
            - response.output_item.done
            - response.content_part.added
            - response.content_part.done
            - response.output_text.delta
            - response.output_text.done
            - response.reasoning_summary_part.added
            - response.reasoning_summary_part.done
            - response.reasoning_summary_text.delta
            - response.reasoning_summary_text.done
            - response.function_call_arguments.delta
            - response.function_call_arguments.done
            - response.custom_tool_call_input.delta
            - response.custom_tool_call_input.done
            - response.web_search_call.in_progress
            - response.web_search_call.searching
            - response.web_search_call.completed
            - response.completed
            - response.incomplete
            - response.failed
            - error
        sequence_number:
          type: integer
          description: Event sequence number, increasing monotonically from 0.
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              description: Error message explaining the cause.
            type:
              type: string
              description: Error type
            code:
              type: string
              description: Error code
          required:
            - message
      required:
        - error
    ResponsesInputItem:
      description: >-
        An input-array element, distinguished by `type`. If `type` is omitted,
        it is treated as `message`.
      oneOf:
        - $ref: '#/components/schemas/ResponsesMessageItem'
        - $ref: '#/components/schemas/ResponsesReasoningItem'
        - $ref: '#/components/schemas/ResponsesFunctionCallItem'
        - $ref: '#/components/schemas/ResponsesFunctionCallOutputItem'
        - $ref: '#/components/schemas/ResponsesCustomToolCallItem'
        - $ref: '#/components/schemas/ResponsesCustomToolCallOutputItem'
        - $ref: '#/components/schemas/ResponsesWebSearchCallItem'
        - $ref: '#/components/schemas/ResponsesAdditionalToolsItem'
    ResponsesTool:
      description: >-
        Tool definition, distinguished by `type`. Supports `function`, `custom`
        (only `apply_patch`), `namespace`, and `web_search`; other tool types
        are unsupported.
      oneOf:
        - $ref: '#/components/schemas/ResponsesFunctionTool'
        - $ref: '#/components/schemas/ResponsesCustomTool'
        - $ref: '#/components/schemas/ResponsesNamespaceTool'
        - $ref: '#/components/schemas/ResponsesWebSearchTool'
      discriminator:
        propertyName: type
        mapping:
          function: '#/components/schemas/ResponsesFunctionTool'
          custom: '#/components/schemas/ResponsesCustomTool'
          namespace: '#/components/schemas/ResponsesNamespaceTool'
          web_search: '#/components/schemas/ResponsesWebSearchTool'
    ResponsesToolChoice:
      type: string
      enum:
        - auto
      description: >-
        Controls tool use. With `auto`, the model decides whether to call a
        tool.
    ResponsesOutputItem:
      description: An output-array element, distinguished by `type`.
      oneOf:
        - $ref: '#/components/schemas/ResponsesOutputReasoningItem'
        - $ref: '#/components/schemas/ResponsesOutputMessageItem'
        - $ref: '#/components/schemas/ResponsesOutputFunctionCallItem'
        - $ref: '#/components/schemas/ResponsesOutputCustomToolCallItem'
        - $ref: '#/components/schemas/ResponsesOutputWebSearchCallItem'
      discriminator:
        propertyName: type
        mapping:
          reasoning: '#/components/schemas/ResponsesOutputReasoningItem'
          message: '#/components/schemas/ResponsesOutputMessageItem'
          function_call: '#/components/schemas/ResponsesOutputFunctionCallItem'
          custom_tool_call: '#/components/schemas/ResponsesOutputCustomToolCallItem'
          web_search_call: '#/components/schemas/ResponsesOutputWebSearchCallItem'
    ResponsesUsage:
      type: object
      description: >-
        input_tokens includes cache reads and writes. For the K3.1 series,
        subtract cached_tokens and cache_write_tokens to obtain regular input;
        for `kimi-k3`, subtract only cached_tokens. output_tokens already
        includes reasoning.
      properties:
        input_tokens:
          type: integer
          description: Input token count, including cache hits.
        input_tokens_details:
          type: object
          properties:
            cached_tokens:
              type: integer
              description: Tokens read from the context cache.
            cache_write_tokens:
              type: integer
              description: Tokens written to the context cache.
        output_tokens:
          type: integer
          description: Output token count, including reasoning tokens.
        output_tokens_details:
          type: object
          properties:
            reasoning_tokens:
              type: integer
              description: Tokens used for reasoning.
        total_tokens:
          type: integer
          description: Total token count.
    ResponsesMessageItem:
      type: object
      title: Message
      description: A conversation message. `type` may be omitted.
      required:
        - role
        - content
      properties:
        type:
          type: string
          enum:
            - message
        role:
          type: string
          enum:
            - user
            - assistant
            - developer
          description: Message role. `developer` is treated as system instructions.
        content:
          description: Message content as a string or content-part array.
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ResponsesInputContentPart'
        status:
          type: string
          enum:
            - completed
    ResponsesReasoningItem:
      type: object
      title: Reasoning
      description: >-
        Replay reasoning from the previous turn. `content` takes precedence over
        `summary`.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - reasoning
        id:
          type: string
        summary:
          type: array
          items:
            type: object
            required:
              - type
              - text
            properties:
              type:
                type: string
                enum:
                  - summary_text
              text:
                type: string
        content:
          type: array
          items:
            type: object
            required:
              - type
              - text
            properties:
              type:
                type: string
                enum:
                  - reasoning_text
              text:
                type: string
        status:
          type: string
          enum:
            - completed
    ResponsesFunctionCallItem:
      type: object
      title: Function Call
      description: Replay a function call.
      required:
        - type
        - call_id
        - name
        - arguments
      properties:
        type:
          type: string
          enum:
            - function_call
        id:
          type: string
        call_id:
          type: string
          description: Call ID paired with the corresponding `function_call_output`.
        name:
          type: string
        namespace:
          type: string
          description: Tool namespace, returned for namespaced tool calls.
        arguments:
          type: string
          description: Function arguments as a JSON string.
        status:
          type: string
          enum:
            - completed
    ResponsesFunctionCallOutputItem:
      type: object
      title: Function call result
      description: Execution result of a function call.
      required:
        - type
        - call_id
        - output
      properties:
        type:
          type: string
          enum:
            - function_call_output
        call_id:
          type: string
          description: Same call ID as the corresponding `function_call`.
        output:
          description: Content returned by the tool.
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ResponsesInputContentPart'
        status:
          type: string
          enum:
            - completed
    ResponsesCustomToolCallItem:
      type: object
      title: Custom tool call
      description: Replay a custom tool call.
      required:
        - type
        - call_id
        - name
        - input
      properties:
        type:
          type: string
          enum:
            - custom_tool_call
        id:
          type: string
        call_id:
          type: string
          description: Call ID paired with the corresponding `custom_tool_call_output`.
        name:
          type: string
        namespace:
          type: string
          description: Tool namespace, returned for namespaced tool calls.
        input:
          type: string
          description: Free-form text input generated by the model.
        status:
          type: string
          enum:
            - completed
    ResponsesCustomToolCallOutputItem:
      type: object
      title: Custom tool call result
      description: Execution result of a custom tool call.
      required:
        - type
        - call_id
        - output
      properties:
        type:
          type: string
          enum:
            - custom_tool_call_output
        call_id:
          type: string
          description: Same call ID as the corresponding `custom_tool_call`.
        output:
          description: Content returned by the tool.
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ResponsesInputContentPart'
        status:
          type: string
          enum:
            - completed
    ResponsesWebSearchCallItem:
      type: object
      title: Web search call
      description: >-
        A previous web search record. Include it with the complete conversation
        history.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - web_search_call
        id:
          type: string
        status:
          type: string
          enum:
            - completed
        action:
          type: object
          properties:
            type:
              type: string
              enum:
                - search
            query:
              type: string
    ResponsesAdditionalToolsItem:
      type: object
      title: Dynamic tools
      description: >-
        Add callable tools during a conversation, effective from this item's
        position onward.
      required:
        - type
        - role
        - tools
      properties:
        type:
          type: string
          enum:
            - additional_tools
        id:
          type: string
        role:
          type: string
          enum:
            - developer
        tools:
          type: array
          items:
            $ref: '#/components/schemas/ResponsesTool'
    ResponsesFunctionTool:
      type: object
      title: Function tool
      description: Function tool with parameters described by JSON Schema.
      required:
        - type
        - name
      properties:
        type:
          type: string
          enum:
            - function
        name:
          type: string
          description: 'Function name. Must match: ^[a-zA-Z_][a-zA-Z0-9-_]{0,127}$'
          pattern: ^[a-zA-Z_][a-zA-Z0-9-_]{0,127}$
        description:
          type: string
        parameters:
          type: object
          description: JSON Schema describing function parameters.
        strict:
          type: boolean
    ResponsesCustomTool:
      type: object
      title: Custom tool
      description: >-
        Custom tool accepting free-form text. Only a tool named `apply_patch` is
        supported, with a required `grammar` + `lark` format definition. Calls
        appear as `custom_tool_call` items in output.
      required:
        - type
        - name
        - format
      properties:
        type:
          type: string
          enum:
            - custom
        name:
          type: string
          enum:
            - apply_patch
          description: Tool name; only `apply_patch` is supported.
        description:
          type: string
        format:
          type: object
          description: >-
            Input-format constraints. Only type `grammar` with syntax `lark` is
            supported.
          required:
            - type
            - syntax
            - definition
          properties:
            type:
              type: string
              enum:
                - grammar
            syntax:
              type: string
              enum:
                - lark
            definition:
              type: string
              description: Lark grammar definition.
    ResponsesNamespaceTool:
      type: object
      title: Namespace tool
      description: Group function tools or custom tools under one namespace.
      required:
        - type
        - name
        - description
        - tools
      properties:
        type:
          type: string
          enum:
            - namespace
        name:
          type: string
        description:
          type: string
        tools:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/ResponsesFunctionTool'
              - $ref: '#/components/schemas/ResponsesCustomTool'
    ResponsesWebSearchTool:
      type: object
      title: Web search tool
      description: >-
        Web search tool, called when the model needs online information. Search
        records appear as web_search_call items. Declare at most one per
        request.
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - web_search
        filters:
          type: object
          description: Search-scope filters.
          properties:
            allowed_domains:
              type: array
              items:
                type: string
              maxItems: 100
              description: Search only these domains, up to 100.
        search_content_types:
          type: array
          items:
            type: string
            enum:
              - text
              - image
          default:
            - text
          description: >-
            Search content types; defaults to `text` only. Including `image`
            also runs image search.
        image_settings:
          type: object
          description: >-
            Image search settings, only effective when `search_content_types`
            includes `image`.
          properties:
            max_results:
              type: integer
              minimum: 1
              maximum: 10
              default: 3
              description: Maximum number of returned images.
            caption:
              type: boolean
              default: false
              description: Whether to generate image captions.
    ResponsesOutputReasoningItem:
      type: object
      title: Reasoning
      description: The model's reasoning content.
      properties:
        type:
          type: string
          enum:
            - reasoning
        id:
          type: string
          example: rs_68f0c1c2d3e4f5a6b7c8d9e0
        summary:
          type: array
          description: Reasoning content.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - summary_text
              text:
                type: string
        encrypted_content:
          type:
            - string
            - 'null'
          description: Always `null`.
        status:
          type: string
          enum:
            - in_progress
            - completed
    ResponsesOutputMessageItem:
      type: object
      title: Message
      description: The model's text reply.
      properties:
        type:
          type: string
          enum:
            - message
        id:
          type: string
          example: msg_68f0c1c2d3e4f5a6b7c8d9e0
        role:
          type: string
          enum:
            - assistant
        content:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - output_text
              text:
                type: string
              annotations:
                type: array
                items: {}
        status:
          type: string
          enum:
            - in_progress
            - completed
    ResponsesOutputFunctionCallItem:
      type: object
      title: Function Call
      description: Function call initiated by the model.
      properties:
        type:
          type: string
          enum:
            - function_call
        id:
          type: string
          example: fc_68f0c1c2d3e4f5a6b7c8d9e0
        call_id:
          type: string
          description: Use this value in `function_call_output` when returning the result.
        name:
          type: string
        namespace:
          type: string
          description: Returned for namespaced tool calls.
        arguments:
          type: string
          description: Function arguments as a JSON string.
        status:
          type: string
          enum:
            - in_progress
            - completed
    ResponsesOutputCustomToolCallItem:
      type: object
      title: Custom tool call
      description: Custom tool call initiated by the model.
      properties:
        type:
          type: string
          enum:
            - custom_tool_call
        id:
          type: string
          example: ctc_68f0c1c2d3e4f5a6b7c8d9e0
        call_id:
          type: string
          description: >-
            Use this value in `custom_tool_call_output` when returning the
            result.
        name:
          type: string
        namespace:
          type: string
          description: Returned for namespaced tool calls.
        input:
          type: string
          description: Free-form text input generated by the model.
        status:
          type: string
          enum:
            - in_progress
            - completed
    ResponsesOutputWebSearchCallItem:
      type: object
      title: Web search call
      description: >-
        Server-executed web search call. Returned only when the request includes
        `web_search` and the server decides to search; appears first in the
        output array.
      properties:
        type:
          type: string
          enum:
            - web_search_call
        id:
          type: string
          example: ws_68f0c1c2d3e4f5a6b7c8d9e0
        status:
          type: string
          enum:
            - in_progress
            - completed
        action:
          type: object
          description: Action performed by this search.
          properties:
            type:
              type: string
              enum:
                - search
            query:
              type: string
              description: Search query actually used.
            sources:
              type: array
              description: >-
                Matched web sources. Returned only when `include` contains
                `web_search_call.action.sources`.
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - url
                  url:
                    type: string
                  title:
                    type: string
        results:
          type: array
          description: >-
            Image search results. Returned only when `include` contains
            `web_search_call.results` and `search_content_types` contains
            `image`.
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                  - image_result
              image_url:
                type: string
              thumbnail_url:
                type: string
              source_website_url:
                type: string
              caption:
                type: string
                description: >-
                  Image caption, returned only when `image_settings.caption` is
                  enabled.
    ResponsesInputContentPart:
      description: A content-array element, distinguished by `type`.
      oneOf:
        - type: object
          title: Input text
          required:
            - type
            - text
          properties:
            type:
              type: string
              enum:
                - input_text
            text:
              type: string
        - type: object
          title: Input image
          required:
            - type
            - image_url
          properties:
            type:
              type: string
              enum:
                - input_image
            image_url:
              type: string
              description: >-
                Image data URL, such as `data:image/png;base64,<base64>`. Public
                http(s) URLs are unsupported.
            detail:
              type: string
              enum:
                - auto
                - low
                - high
                - original
        - type: object
          title: Output text
          description: Used to replay assistant text history.
          required:
            - type
            - text
          properties:
            type:
              type: string
              enum:
                - output_text
            text:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        ##All APIs require Bearer Token authentication##


        **Get API Key:**


        Visit [API Key Management Page](https://evolink.ai/dashboard/keys) to
        get your API Key


        **Add to request header:**

        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.