Chicory AI
  • Introduction
    • Introduction to Chicory AI
    • Understanding Chicory
  • Getting Started
    • Quickstart Guide
    • OpenAPI Specification
      • Projects
      • Training
      • Data_sources
      • Messages
      • Chats
      • Health
      • Models
    • Platform - Managed Service
      • How to use?
Powered by GitBook
On this page
  1. Getting Started
  2. OpenAPI Specification

Chats

PreviousMessagesNextHealth

Get Chat

get

Get a chat by ID

Path parameters
project_idstringRequired
chat_idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/projects/{project_id}/chats/{chat_id} HTTP/1.1
Host: api.chicory.ai
Accept: */*

{
  "id": "text",
  "project_id": "text",
  "name": "text",
  "description": "text",
  "owner": "text",
  "message_count": 1,
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}

Delete Chat

delete

Delete a chat

Path parameters
project_idstringRequired
chat_idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/projects/{project_id}/chats/{chat_id} HTTP/1.1
Host: api.chicory.ai
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}
  • GETList Chats
  • POSTCreate Chat
  • GETGet Chat
  • DELETEDelete Chat
  • PATCHUpdate Chat

List Chats

get

List all chats for a project with optional filtering Parameters: - project_id: The ID of the project to list chats for - owner: Optional owner to filter chats by

Path parameters
project_idstringRequired
Query parameters
ownerstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/projects/{project_id}/chats HTTP/1.1
Host: api.chicory.ai
Accept: */*

{
  "chats": [
    {
      "id": "text",
      "project_id": "text",
      "name": "text",
      "description": "text",
      "owner": "text",
      "message_count": 1,
      "created_at": "2025-05-22T05:46:27.578Z",
      "updated_at": "2025-05-22T05:46:27.578Z"
    }
  ]
}

Create Chat

post

Create a new chat for a project

Path parameters
project_idstringRequired
Body

Schema for creating a chat

namestring · min: 1 · max: 100Required
descriptionstring · max: 500Optional
ownerstringOptional

Owner or creator of the chat

Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/projects/{project_id}/chats HTTP/1.1
Host: api.chicory.ai
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "owner": "text"
}
{
  "id": "text",
  "project_id": "text",
  "name": "text",
  "description": "text",
  "owner": "text",
  "message_count": 1,
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}

Update Chat

patch

Update chat information

Path parameters
project_idstringRequired
chat_idstringRequired
Body

Schema for updating a chat

namestring · min: 1 · max: 100Optional
descriptionstring · max: 500Optional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /v1/projects/{project_id}/chats/{chat_id} HTTP/1.1
Host: api.chicory.ai
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}
{
  "id": "text",
  "project_id": "text",
  "name": "text",
  "description": "text",
  "owner": "text",
  "message_count": 1,
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}