---
title: "ChatCompletions"
method: POST
path: "/v1/chat/completions"
tags: ["relay"]
---

# ChatCompletions

`POST /v1/chat/completions`

ChatCompletions

## Headers

- `Aiproxy-Channel` string

## Request body

- ModelGeneralOpenAIRequest
  - `audio` ModelAudio
    - `format` string
    - `voice` string
  - `enable_thinking` boolean
  - `frequency_penalty` number
  - `function_call` unknown
  - `functions` unknown
  - `input` unknown
  - `logit_bias` unknown
  - `logprobs` boolean
  - `max_completion_tokens` integer
  - `max_tokens` integer
  - `messages` ModelMessage[]
    - `audio` ModelOutputAudio
      - `data` string
      - `expires_at` integer
      - `id` string
      - `transcript` string
    - `content` unknown
    - `name` string
    - `reasoning_content` string
    - `role` string
    - `signature` string
    - `tool_call_id` string
    - `tool_calls` ModelToolCall[]
      - `extra_content` ModelExtraContent
        - `google` ModelGoogleExtraContent
          - `thought_signature` string
      - `function` ModelFunction
        - `arguments` string
        - `description` string
        - `name` string
        - `parameters` unknown
      - `id` string
      - `index` integer
      - `type` string
  - `metadata` unknown
  - `model` string
  - `num_ctx` integer
  - `presence_penalty` number
  - `prompt` unknown
  - `prompt_cache_key` string
  - `prompt_cache_retention` string
  - `reasoning_effort` string
  - `response_format` ModelResponseFormat
    - `json_schema` ModelJSONSchema
      - `description` string
      - `name` string
      - `schema` object
      - `strict` boolean
    - `type` string
  - `seed` number
  - `service_tier` string
  - `size` string
  - `stop` unknown
  - `stream` boolean
  - `stream_options` ModelStreamOptions
    - `include_usage` boolean
  - `temperature` number
  - `thinking` ModelGeneralThinking
    - `budget_tokens` integer — when type is "disabled", this field must be 0
    - `type` 'enabled' | 'adaptive' | 'disabled'
  - `thinking_budget` integer
  - `tool_choice` unknown
  - `tools` ModelTool[]
    - `function` ModelFunction
      - `arguments` string
      - `description` string
      - `name` string
      - `parameters` unknown
    - `type` string
  - `top_k` integer
  - `top_logprobs` integer
  - `top_p` number
  - `user` string

## Response `200`

OK

- ModelTextResponse
  - `choices` ModelTextResponseChoice[]
    - `finish_reason` 'stop' | 'length' | 'content_filter' | 'tool_calls' | 'function_call'
    - `index` integer
    - `message` ModelMessage
      - `audio` ModelOutputAudio
        - `data` string
        - `expires_at` integer
        - `id` string
        - `transcript` string
      - `content` unknown
      - `name` string
      - `reasoning_content` string
      - `role` string
      - `signature` string
      - `tool_call_id` string
      - `tool_calls` ModelToolCall[]
        - `extra_content` ModelExtraContent
          - `google` ModelGoogleExtraContent
            - `thought_signature` string
        - `function` ModelFunction
          - `arguments` string
          - `description` string
          - `name` string
          - `parameters` unknown
        - `id` string
        - `index` integer
        - `type` string
    - `text` string
  - `created` integer
  - `id` string
  - `model` string
  - `object` string
  - `usage` ModelChatUsage
    - `completion_tokens` integer
    - `completion_tokens_details` ModelCompletionTokensDetails
      - `accepted_prediction_tokens` integer
      - `audio_tokens` integer
      - `image_tokens` integer
      - `reasoning_tokens` integer
      - `rejected_prediction_tokens` integer
    - `prompt_tokens` integer
    - `prompt_tokens_details` ModelPromptTokensDetails
      - `audio_tokens` integer
      - `cache_creation_tokens` integer
      - `cached_tokens` integer
      - `image_tokens` integer
      - `video_tokens` integer
    - `total_tokens` integer
    - `web_search_count` integer

---

[API](https://skmtc.net/labring/apis/ai-proxy-swagger-api.md) · [All operations](https://skmtc.net/labring/apis/ai-proxy-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/labring/ai-proxy-swagger-api/versions/e471487f2a2f/schema)
