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

Training

PreviousProjectsNextData_sources

Get Training Job

get

Get the status of a training job

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

{
  "id": "text",
  "project_id": "text",
  "data_source_ids": [
    "text"
  ],
  "status": "text",
  "description": "text",
  "progress": {},
  "error": "text",
  "created_at": "2025-05-21T22:33:01.325Z",
  "updated_at": "2025-05-21T22:33:01.325Z"
}

Delete Training Job

delete

Delete a training job

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

No content
  • GETList Training Jobs
  • POSTCreate Training Job
  • GETGet Training Job
  • PUTUpdate Training Job
  • DELETEDelete Training Job

List Training Jobs

get

List all training jobs for a project

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

{
  "training_jobs": [
    {
      "id": "text",
      "project_id": "text",
      "data_source_ids": [
        "text"
      ],
      "status": "text",
      "description": "text",
      "progress": {},
      "error": "text",
      "created_at": "2025-05-21T22:33:01.325Z",
      "updated_at": "2025-05-21T22:33:01.325Z"
    }
  ]
}

Create Training Job

post

Start a new training job for a project

Path parameters
project_idstringRequired
Body

Schema for creating a training job

data_source_idsstring[]Required

List of data source IDs to include in training

descriptionstring · max: 500Optional

Optional description of the training job

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

{
  "data_source_ids": [
    "text"
  ],
  "description": "text"
}
{
  "id": "text",
  "project_id": "text",
  "data_source_ids": [
    "text"
  ],
  "status": "text",
  "description": "text",
  "progress": {},
  "error": "text",
  "created_at": "2025-05-21T22:33:01.325Z",
  "updated_at": "2025-05-21T22:33:01.325Z"
}

Update Training Job

put

Update a training job

Path parameters
project_idstringRequired
training_idstringRequired
Body

Schema for updating a training job

statusstringOptional
descriptionstring · max: 500Optional
progressobject · ProgressOptional
errorstringOptional
data_source_idsstring[]Optional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
put
PUT /v1/projects/{project_id}/training/{training_id} HTTP/1.1
Host: api.chicory.ai
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "status": "text",
  "description": "text",
  "progress": {},
  "error": "text",
  "data_source_ids": [
    "text"
  ]
}
{
  "id": "text",
  "project_id": "text",
  "data_source_ids": [
    "text"
  ],
  "status": "text",
  "description": "text",
  "progress": {},
  "error": "text",
  "created_at": "2025-05-21T22:33:01.325Z",
  "updated_at": "2025-05-21T22:33:01.325Z"
}