对话（Chat）API：文本生成

OpenAPI Specification

openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v3/chat/completions:
    post:
      summary: 对话(Chat)-文本 API
      deprecated: false
      description: >-
        本文介绍Doubao语言大模型API的输入输出参数，供您使用接口向大模型发起文字对话请求时查阅字段含义。您如果希望查看接口使用示例以及使用说明，可以参考教程[文本生成](https://www.volcengine.com/docs/82379/1399009)。
      tags:
        - 对话(Chat) API
      parameters:
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: false
          example: Bearer {{ARK_API_KEY}}
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                model:
                  type: string
                messages:
                  type: array
                  items:
                    type: object
                    properties:
                      role:
                        type: string
                      content:
                        type: string
                    required:
                      - role
                      - content
              required:
                - model
                - messages
            example:
              model: doubao-pro-32k-240615
              messages:
                - role: system
                  content: You are a helpful assistant.
                - role: user
                  content: Hello!
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  object:
                    type: string
                  created:
                    type: integer
                  model:
                    type: string
                  choices:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                        message:
                          type: object
                          properties:
                            role:
                              type: string
                            content:
                              type: string
                          required:
                            - role
                            - content
                          x-apifox-orders:
                            - role
                            - content
                        logprobs:
                          type: 'null'
                        finish_reason:
                          type: string
                      x-apifox-orders:
                        - index
                        - message
                        - logprobs
                        - finish_reason
                  usage:
                    type: object
                    properties:
                      prompt_tokens:
                        type: integer
                      completion_tokens:
                        type: integer
                      total_tokens:
                        type: integer
                      prompt_tokens_details:
                        type: object
                        properties:
                          cached_tokens:
                            type: integer
                        required:
                          - cached_tokens
                        x-apifox-orders:
                          - cached_tokens
                    required:
                      - prompt_tokens
                      - completion_tokens
                      - total_tokens
                      - prompt_tokens_details
                    x-apifox-orders:
                      - prompt_tokens
                      - completion_tokens
                      - total_tokens
                      - prompt_tokens_details
                required:
                  - id
                  - object
                  - created
                  - model
                  - choices
                  - usage
                x-apifox-orders:
                  - id
                  - object
                  - created
                  - model
                  - choices
                  - usage
              example:
                id: 021718067849899d92fcbe0865fdffdde********************
                object: chat.completion
                created: 1720582714
                model: doubao-pro-32k-240615
                choices:
                  - index: 0
                    message:
                      role: assistant
                      content: Hello, can i help you with something?
                    logprobs: null
                    finish_reason: stop
                usage:
                  prompt_tokens: 22
                  completion_tokens: 9
                  total_tokens: 31
                  prompt_tokens_details:
                    cached_tokens: 0
          headers: {}
          x-apifox-name: 成功
      security: []
      x-apifox-folder: 对话(Chat) API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/5937556/apis/api-265892759-run
components:
  schemas: {}
  securitySchemes:
    bearer:
      type: bearer
      scheme: bearer
servers:
  - url: https://ark.cn-beijing.volces.com/api/v3
    description: 正式环境
security:
  - bearer: []
    x-apifox:
      required: true
      schemeGroups:
        - id: BttezrgK6TNhVz64PPOnX
          schemeIds:
            - bearer
      use:
        id: BttezrgK6TNhVz64PPOnX