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

Projects

PreviousOpenAPI SpecificationNextTraining

Get Project

get

Get a project by ID

Path parameters
project_idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/projects/{project_id} HTTP/1.1
Host: api.chicory.ai
Accept: */*
{
  "id": "text",
  "organization_id": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}

Delete Project

delete

Delete a project

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

No content

  • GETList Projects
  • POSTCreate Project
  • GETGet Project
  • PUTUpdate Project
  • DELETEDelete Project

List Projects

get

List all projects, optionally filtered by organization_id

Query parameters
organization_idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/projects HTTP/1.1
Host: api.chicory.ai
Accept: */*
{
  "projects": [
    {
      "id": "text",
      "organization_id": "text",
      "name": "text",
      "description": "text",
      "created_at": "2025-05-22T05:46:27.578Z",
      "updated_at": "2025-05-22T05:46:27.578Z"
    }
  ]
}

Create Project

post

Create a new project

Body

Schema for creating a project

namestring · min: 1 · max: 100Required
organization_idstring · min: 1Required
descriptionstring · max: 500Optional
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/projects HTTP/1.1
Host: api.chicory.ai
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "name": "text",
  "organization_id": "text",
  "description": "text"
}
{
  "id": "text",
  "organization_id": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}

Update Project

put

Update a project

Path parameters
project_idstringRequired
Body

Schema for updating a project

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

{
  "name": "text",
  "description": "text"
}
{
  "id": "text",
  "organization_id": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-05-22T05:46:27.578Z",
  "updated_at": "2025-05-22T05:46:27.578Z"
}