---
title: "Chat"
method: POST
path: "/api/v1/chat/completions"
tags: ["Chat"]
---

# Chat

`POST /api/v1/chat/completions`

## Headers

- `CodeGPT-Org-Id` string

## Request body

- union
  - Chat — Our completion model request
    - `stream` boolean — Stream Output
    - `agentId` string, required — Id of the agent to use for the completion
    - `messages` Message[], required — List of messages with a role and content
      - `role` 'system' | 'user' | 'assistant', required — Role of the message
      - `content` string, required — Content of the message
    - `format` boolean — Format of the response
  - ChatLegacy — Our old completion model request
    - `stream` boolean — Stream Output
    - `agent` string, required — Id of the agent to use for the completion
    - `messages` Message[], required — List of messages with a role and content
      - `role` 'system' | 'user' | 'assistant', required — Role of the message
      - `content` string, required — Content of the message

## Response `200`

Successful Response

- CompletionOpenAIFormat — Chat completion model response
  - `agentName` string, required — Name of the agent
  - `choices` object[], required — Array of choices with a single item
    - `message` Message
      - `role` 'system' | 'user' | 'assistant', required — Role of the message
      - `content` string, required — Content of the message

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/codegpt/apis/codegpt-api-beta.md) · [All operations](https://skmtc.dev/codegpt/apis/codegpt-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codegpt/codegpt-api-beta/revisions/0a70b3b0cec3/schema)