Kore.ai Chat API

The Chat API from Kore.ai — 5 operation(s) for chat.

Operations 5

POST /api/v1/chat/agent Agent-backed chat (legacy) #
POST /api/v1/chat/agent/stream Agent-backed SSE streaming chat (legacy) #
POST /api/v1/chat/complete Non-streaming chat completion (legacy) #
POST /api/v1/chat/session Create a chat session (legacy) #
GET /api/v1/chat/usage Get usage metrics (legacy) #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/koreai-chat-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

koreai-chat-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Koreai Chat API
  version: 1.0.0
  x-generated: 'do not edit; source: route contracts'
  description: 'Operations tagged Chat across 2 of this provider''s published API definitions: koreai-abl-runtime-conversation-openapi.json, koreai-abl-runtime-sessions-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Chat
paths:
  /api/v1/chat/agent:
    post:
      deprecated: true
      description: Deprecated — prefer the deployment-scoped `/api/v1/project/{projectSlug}/{env}/agent/{agentSlug}/chat`. Executes a message through the ABL runtime with agent-backed chat; creates a session on first call or reuses one via sessionId.
      operationId: runtime.legacyChat.agent
      requestBody:
        content:
          application/json:
            schema:
              properties:
                agentId:
                  description: Optional agent override
                  type: string
                attachmentIds:
                  items:
                    type: string
                  type: array
                message:
                  description: User message text
                  type: string
                metadata:
                  additionalProperties: {}
                  type: object
                projectId:
                  description: Project id
                  type: string
                sessionId:
                  description: Existing session id to continue the conversation
                  type: string
              required:
              - projectId
              - message
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  action:
                    additionalProperties: {}
                    type: object
                  outcome:
                    type: string
                  response:
                    type: string
                  sessionId:
                    type: string
                required:
                - sessionId
                - response
                type: object
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - ApiKeyAuth: []
      summary: Agent-backed chat (legacy)
      tags:
      - Chat
  /api/v1/chat/agent/stream:
    post:
      deprecated: true
      description: Deprecated — prefer the deployment-scoped `/api/v1/project/{projectSlug}/{env}/agent/{agentSlug}/stream`. Streams tokens and trace events via Server-Sent Events.
      operationId: runtime.legacyChat.stream
      requestBody:
        content:
          application/json:
            schema:
              properties:
                agentId:
                  description: Optional agent override
                  type: string
                attachmentIds:
                  items:
                    type: string
                  type: array
                message:
                  description: User message text
                  type: string
                metadata:
                  additionalProperties: {}
                  type: object
                projectId:
                  description: Project id
                  type: string
                sessionId:
                  description: Existing session id to continue the conversation
                  type: string
              required:
              - projectId
              - message
              type: object
      responses:
        '200':
          content:
            text/event-stream:
              schema:
                type: string
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - ApiKeyAuth: []
      summary: Agent-backed SSE streaming chat (legacy)
      tags:
      - Chat
  /api/v1/chat/complete:
    post:
      deprecated: true
      description: Deprecated — prefer the deployment-scoped `/api/v1/project/{projectSlug}/{env}/agent/{agentSlug}/complete`. Non-streaming completion with model routing and usage tracking.
      operationId: runtime.legacyChat.complete
      requestBody:
        content:
          application/json:
            schema:
              properties:
                maxTokens:
                  type: number
                messages:
                  description: Conversation messages
                  items:
                    properties:
                      content:
                        type: string
                      role:
                        enum:
                        - system
                        - user
                        - assistant
                        - tool
                        type: string
                    required:
                    - role
                    - content
                    type: object
                  type: array
                modelId:
                  type: string
                projectId:
                  description: Project id
                  type: string
                temperature:
                  type: number
              required:
              - projectId
              - messages
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  content:
                    type: string
                  finishReason:
                    type: string
                  latencyMs:
                    type: number
                  model:
                    type: string
                  usage:
                    properties:
                      estimatedCost:
                        type:
                        - number
                        - 'null'
                      inputTokens:
                        type: number
                      outputTokens:
                        type: number
                      totalTokens:
                        type: number
                    required:
                    - inputTokens
                    - outputTokens
                    - totalTokens
                    - estimatedCost
                    type: object
                required:
                - content
                - usage
                - latencyMs
                type: object
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - ApiKeyAuth: []
      summary: Non-streaming chat completion (legacy)
      tags:
      - Chat
  /api/v1/chat/session:
    post:
      deprecated: true
      description: Deprecated — creates a pre-initialized session with optional session metadata. Returns the session ID without executing a message.
      operationId: runtime.legacyChat.createSession
      requestBody:
        content:
          application/json:
            schema:
              properties:
                agentId:
                  type: string
                deploymentId:
                  type: string
                environment:
                  type: string
                projectId:
                  minLength: 1
                  type: string
                sessionMetadata:
                  additionalProperties: {}
                  type: object
              required:
              - projectId
              type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  agentName:
                    type: string
                  sessionId:
                    type: string
                  status:
                    enum:
                    - ready
                    type: string
                required:
                - sessionId
                - agentName
                - status
                type: object
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - ApiKeyAuth: []
      summary: Create a chat session (legacy)
      tags:
      - Chat
  /api/v1/chat/usage:
    get:
      description: Usage metrics for a project with optional date range and grouping.
      operationId: runtime.legacyChat.getUsage
      parameters:
      - description: Project id
        in: query
        name: projectId
        required: true
        schema:
          description: Project id
          type: string
      - description: ISO 8601 start date
        in: query
        name: startDate
        required: false
        schema:
          description: ISO 8601 start date
          type: string
      - description: ISO 8601 end date
        in: query
        name: endDate
        required: false
        schema:
          description: ISO 8601 end date
          type: string
      - description: Group usage by model
        in: query
        name: groupBy
        required: false
        schema:
          description: Group usage by model
          enum:
          - model
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  byModel:
                    items:
                      properties:
                        modelId:
                          type: string
                        provider:
                          type: string
                        requestCount:
                          type: number
                        totalCost:
                          type: number
                        totalTokens:
                          type: number
                      required:
                      - modelId
                      - provider
                      - totalTokens
                      - totalCost
                      - requestCount
                      type: object
                    type: array
                  summary:
                    properties:
                      avgLatency:
                        type: number
                      requestCount:
                        type: number
                      totalCost:
                        type: number
                      totalTokens:
                        type: number
                    required:
                    - totalTokens
                    - totalCost
                    - requestCount
                    - avgLatency
                    type: object
                required:
                - byModel
                type: object
          description: Success
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - ApiKeyAuth: []
      summary: Get usage metrics (legacy)
      tags:
      - Chat
components:
  schemas:
    ErrorResponse:
      properties:
        error:
          type: string
      required:
      - error
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey
x-refined-from:
- koreai-abl-runtime-conversation-openapi.json
- koreai-abl-runtime-sessions-openapi.json