---
title: "Chat"
method: POST
path: "/api/external/chatbot/{chatbotId}/chat"
---

# Chat

`POST /api/external/chatbot/{chatbotId}/chat`

Chat

## Query parameters

- `stream` string

## Headers

- `x-api-key` string

## Request body

- object
  - `messages` object[]
    - `content` string
    - `role` string
  - `platform` string
  - `sessionToken` string

## Response `200`

Non stream response / Stream Response / Non stream response / Stream Response

- object
  - `finish_reason` string
  - `output` string
  - `steps` object[]
    - `experimental_providerMetadata` object
      - `openai` object
        - `cachedPromptTokens` number
        - `reasoningTokens` number
    - `finishReason` string
    - `isContinued` boolean
    - `request` object
      - `body` string
    - `response` object
      - `headers` object
        - `access-control-expose-headers` string
        - `alt-svc` string
        - `cf-cache-status` string
        - `cf-ray` string
        - `connection` string
        - `content-encoding` string
        - `content-type` string
        - `date` string
        - `openai-organization` string
        - `openai-processing-ms` string
        - `openai-version` string
        - `server` string
        - `set-cookie` string
        - `strict-transport-security` string
        - `transfer-encoding` string
        - `x-content-type-options` string
        - `x-ratelimit-limit-requests` string
        - `x-ratelimit-limit-tokens` string
        - `x-ratelimit-remaining-requests` string
        - `x-ratelimit-remaining-tokens` string
        - `x-ratelimit-reset-requests` string
        - `x-ratelimit-reset-tokens` string
        - `x-request-id` string
      - `id` string
      - `messages` object[]
        - `content` object[]
          - `text` string
          - `type` string
        - `role` string
      - `modelId` string
      - `timestamp` string
    - `stepType` string
    - `text` string
    - `toolCalls` unknown[]
      - unknown
    - `toolResults` unknown[]
      - unknown
    - `usage` object
      - `completionTokens` number
      - `promptTokens` number
      - `totalTokens` number
    - `warnings` unknown[]
      - unknown
  - `tool_calls` unknown[]
    - unknown
  - `tool_results` unknown[]
    - unknown

## Changes

- **2025-01-24** `6942be06fd1e` — 1 info
  - for the `query` request parameter `stream`, the type/format was generalized from `boolean`/`` to `string`/``
- **2025-01-22** `f41093f979a7` — 1 breaking
  - for the `query` request parameter `stream`, the type/format was changed from `string`/`` to `boolean`/``
- **2025-01-22** `ed6a626deb6d` — 1 info
  - endpoint added
- **2025-01-22** `9a74b2d0931e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/dasomx/apis/okchat2-0/changes/api/external/chatbot/:chatbotId/chat/post.md)

---

[API](https://skmtc.dev/dasomx/apis/okchat2-0.md) · [All operations](https://skmtc.dev/dasomx/apis/okchat2-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/dasomx/okchat2-0/revisions/53c69266d405/schema)