API docs by Redocly

Kiln AI Server (0.23.0)

Download OpenAPI specification:

Learn more about Kiln AI at https://github.com/kiln-ai/kiln

Ping

Ping the server 🏓

Responses

Response samples

Content type
application/json
null

Create Project

Request Body schema: application/json
required
v
integer (V)
Default: 1
Id (string) or Id (null) (Id)
Path (string) or Path (null) (Path)
created_at
string <date-time> (Created At)
created_by
string (Created By)
name
required
string (Name)

The name of the project.

Description (string) or Description (null) (Description)

A description of the project for you and your team. Will not be used in prompts/training/validation.

Responses

Request samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_type": "string"
}

Update Project

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_type": "string"
}

Get Projects

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Project

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_type": "string"
}

Delete Project

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
{ }

Import Project

query Parameters
project_path
required
string (Project Path)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_type": "string"
}

Create Task

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "instruction": "string",
  • "requirements": [ ],
  • "output_json_schema": "string",
  • "input_json_schema": "string",
  • "thinking_instruction": "string",
  • "default_run_config_id": "string",
  • "model_type": "string"
}

Update Task

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "instruction": "string",
  • "requirements": [ ],
  • "output_json_schema": "string",
  • "input_json_schema": "string",
  • "thinking_instruction": "string",
  • "default_run_config_id": "string",
  • "model_type": "string"
}

Delete Task

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
null

Get Tasks

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Task

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "instruction": "string",
  • "requirements": [ ],
  • "output_json_schema": "string",
  • "input_json_schema": "string",
  • "thinking_instruction": "string",
  • "default_run_config_id": "string",
  • "model_type": "string"
}

Get Rating Options

Generates an object which determines which rating options should be shown for a given dataset item.

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "options": [
    ]
}

Create Prompt

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)
prompt
required
string (Prompt)
Chain Of Thought Instructions (string) or Chain Of Thought Instructions (null) (Chain Of Thought Instructions)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "prompt": "string",
  • "chain_of_thought_instructions": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "generator_id": "string",
  • "prompt": "string",
  • "chain_of_thought_instructions": "string",
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "model_type": "string"
}

Get Prompts

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "generators": [
    ],
  • "prompts": [
    ]
}

Update Prompt

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
prompt_id
required
string (Prompt Id)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "generator_id": "string",
  • "prompt": "string",
  • "chain_of_thought_instructions": "string",
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "model_type": "string"
}

Delete Prompt

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
prompt_id
required
string (Prompt Id)

Responses

Response samples

Content type
application/json
null

Get Run

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "tags": [ ],
  • "usage": {
    },
  • "trace": [
    ],
  • "model_type": "string"
}

Delete Run

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
run_id
required
string (Run Id)

Responses

Response samples

Content type
application/json
null

Update Run

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
run_id
required
string (Run Id)
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "tags": [ ],
  • "usage": {
    },
  • "trace": [
    ],
  • "model_type": "string"
}

Get Runs

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Runs Summary

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Runs

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
null

Run Task

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: application/json
required
required
object (RunConfigProperties)

A configuration for running a task.

This includes everything needed to run a task, except the input and task ID. Running the same RunConfig with the same input should make identical calls to the model (output may vary as models are non-deterministic).

Plaintext Input (string) or Plaintext Input (null) (Plaintext Input)
Structured Input (object) or Array of Structured Input (any) or Structured Input (null) (Structured Input)
Array of Tags (strings) or Tags (null) (Tags)

Responses

Request samples

Content type
application/json
{
  • "run_config_properties": {
    },
  • "plaintext_input": "string",
  • "structured_input": { },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "input": "string",
  • "input_source": {
    },
  • "output": {
    },
  • "repair_instructions": "string",
  • "repaired_output": {
    },
  • "intermediate_outputs": {
    },
  • "tags": [ ],
  • "usage": {
    },
  • "trace": [
    ],
  • "model_type": "string"
}

Edit Tags

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: application/json
required
run_ids
required
Array of strings (Run Ids)
Array of Add Tags (strings) or Add Tags (null) (Add Tags)
Array of Remove Tags (strings) or Remove Tags (null) (Remove Tags)

Responses

Request samples

Content type
application/json
{
  • "run_ids": [
    ],
  • "add_tags": [
    ],
  • "remove_tags": [
    ]
}

Response samples

Content type
application/json
null

Bulk Upload

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)
Request Body schema: multipart/form-data
required
file
required
string <binary> (File)
Splits (string) or Splits (null) (Splits)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "filename": "string",
  • "imported_count": 0
}

Get Tags

path Parameters
project_id
required
string (Project Id)
task_id
required
string (Task Id)

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Create Documents Bulk

path Parameters
project_id
required
string (Project Id)
Request Body schema: multipart/form-data
Array of Files (strings) or Files (null) (Files)
Array of Names (strings) or Names (null) (Names)
Array of Tags (strings) or Tags (null) (Tags)

Responses

Response samples

Content type
application/json
{
  • "created_documents": [
    ],
  • "failed_files": [
    ]
}

Get Documents

path Parameters
project_id
required
string (Project Id)
query Parameters
Tags (string) or Tags (null) (Tags)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Extractions For Extractor Config

Return mapping of document id to list of extractions for the given extractor config id.

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get Document Tags

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get Document Tag Counts

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

Get Document

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "name_override": "string",
  • "description": "string",
  • "original_file": {
    },
  • "kind": "document",
  • "tags": [
    ],
  • "model_type": "string",
  • "friendly_name": "string"
}

Patch Document

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)
Request Body schema: application/json
required
Name Override (string) or Name Override (null) (Name Override)

A name for this document.

Description (string) or Description (null) (Description)

The description of the document

Array of Tags (strings) or Tags (null) (Tags)

Tags for the document

Responses

Request samples

Content type
application/json
{
  • "name_override": "string",
  • "description": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "name_override": "string",
  • "description": "string",
  • "original_file": {
    },
  • "kind": "document",
  • "tags": [
    ],
  • "model_type": "string",
  • "friendly_name": "string"
}

Delete Document

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)

Responses

Response samples

Content type
application/json
{ }

Edit Tags

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
document_ids
required
Array of strings (Document Ids)
Array of Add Tags (strings) or Add Tags (null) (Add Tags)
Array of Remove Tags (strings) or Remove Tags (null) (Remove Tags)

Responses

Request samples

Content type
application/json
{
  • "document_ids": [
    ],
  • "add_tags": [
    ],
  • "remove_tags": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

Create Extractor Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the extractor config

model_provider_name
required
string (ModelProviderName)
Enum: "openai" "groq" "amazon_bedrock" "ollama" "openrouter" "fireworks_ai" "kiln_fine_tune" "kiln_custom_registry" "openai_compatible" "anthropic" "gemini_api" "azure_openai" "huggingface" "vertex" "together_ai" "siliconflow_cn" "cerebras" "docker_model_runner"

The name of the model provider to use for the extractor config.

model_name
required
string (Model Name)

The name of the model to use for the extractor config.

output_format
required
string (OutputFormat)
Enum: "text/plain" "text/markdown"

The output format of the extractor config

passthrough_mimetypes
Array of strings (Passthrough Mimetypes)
Items Enum: "text/plain" "text/markdown"

The mimetypes to pass through to the extractor

required
object (LitellmExtractorConfigProperties)

The properties of the extractor config, specific to the selected extractor_type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "model_provider_name": "openai",
  • "model_name": "string",
  • "output_format": "text/plain",
  • "passthrough_mimetypes": [
    ],
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "is_archived": false,
  • "description": "string",
  • "model_provider_name": "string",
  • "model_name": "string",
  • "output_format": "text/plain",
  • "passthrough_mimetypes": [
    ],
  • "extractor_type": "litellm",
  • "properties": {
    },
  • "model_type": "string"
}

Get Extractor Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Extractor Config

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "is_archived": false,
  • "description": "string",
  • "model_provider_name": "string",
  • "model_name": "string",
  • "output_format": "text/plain",
  • "passthrough_mimetypes": [
    ],
  • "extractor_type": "litellm",
  • "properties": {
    },
  • "model_type": "string"
}

Patch Extractor Config

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the extractor config

Is Archived (boolean) or Is Archived (null) (Is Archived)

Whether the extractor config is archived

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_archived": true
}

Response samples

Content type
application/json
{ }

Run Extractor Config

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)
query Parameters
Tags (string) or Tags (null) (Tags)

Responses

Response samples

Content type
application/json
null

Get Extractions

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Extraction

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)
extraction_id
required
string (Extraction Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "source": "string",
  • "output_content": "string",
  • "extractor": {
    }
}

Delete Extraction

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)
extraction_id
required
string (Extraction Id)

Responses

Response samples

Content type
application/json
{ }

Download Document File

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)

Responses

Response samples

Content type
application/json
null

Open Document Enclosing Folder

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)

Responses

Response samples

Content type
application/json
{
  • "path": "string"
}

Delete Documents

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{ }

Get Extraction Progress

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)

Responses

Response samples

Content type
application/json
{
  • "document_count_total": 0,
  • "document_count_successful": 0,
  • "extractor_config": {
    }
}

Extract File

path Parameters
project_id
required
string (Project Id)
document_id
required
string (Document Id)
Request Body schema: application/json
Any of
Array
Any of
string

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null

Create Chunker Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the chunker config

chunker_type
required
string (ChunkerType)
Enum: "fixed_window" "semantic"

The type of the chunker

required
any (Properties)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "chunker_type": "fixed_window",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "chunker_type": "fixed_window",
  • "properties": {
    },
  • "model_type": "string"
}

Get Chunker Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Embedding Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the embedding config

model_provider_name
required
string (ModelProviderName)
Enum: "openai" "groq" "amazon_bedrock" "ollama" "openrouter" "fireworks_ai" "kiln_fine_tune" "kiln_custom_registry" "openai_compatible" "anthropic" "gemini_api" "azure_openai" "huggingface" "vertex" "together_ai" "siliconflow_cn" "cerebras" "docker_model_runner"

The provider of the embedding model

model_name
required
string (EmbeddingModelName)
Enum: "openai_text_embedding_3_small" "openai_text_embedding_3_large" "gemini_text_embedding_004" "gemini_embedding_001" "embedding_gemma_300m" "nomic_text_embedding_v1_5" "qwen_3_embedding_0p6b" "qwen_3_embedding_4b" "qwen_3_embedding_8b" "baai_bge_small_1_5" "baai_bge_base_1_5" "baai_bge_large_1_5" "m2_bert_retrieval_32k" "gte_modernbert_base" "multilingual_e5_large_instruct" "thenlper_gte_large" "thenlper_gte_base" "where_is_ai_uae_large_v1" "mixedbread_ai_mxbai_embed_large_v1" "netease_youdao_bce_embedding_base_v1" "openai_text_embedding_ada_002" "mistral_embed_text_2312" "mistral_codestral_embed_2505"

The name of the embedding model

object (EmbeddingProperties)

Properties to be used to execute the embedding config.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "model_provider_name": "openai",
  • "model_name": "openai_text_embedding_3_small",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_provider_name": "openai",
  • "model_name": "string",
  • "properties": {
    },
  • "model_type": "string"
}

Get Embedding Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Reranker Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the reranker config

top_n
required
integer (Top N) > 0

Number of results to return from the reranker

model_provider_name
required
string (ModelProviderName)
Enum: "openai" "groq" "amazon_bedrock" "ollama" "openrouter" "fireworks_ai" "kiln_fine_tune" "kiln_custom_registry" "openai_compatible" "anthropic" "gemini_api" "azure_openai" "huggingface" "vertex" "together_ai" "siliconflow_cn" "cerebras" "docker_model_runner"

The name of the model provider to use for the reranker config.

model_name
required
string (Model Name)

The name of the model to use for the reranker config.

object (CohereCompatibleProperties)
Default: {"type":"cohere_compatible"}

The properties of the reranker config.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "top_n": 0,
  • "model_provider_name": "openai",
  • "model_name": "string",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "top_n": 0,
  • "model_provider_name": "string",
  • "model_name": "string",
  • "properties": {
    },
  • "model_type": "string"
}

Get Reranker Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Embedding Config

path Parameters
project_id
required
string (Project Id)
embedding_config_id
required
string (Embedding Config Id)

Responses

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "model_provider_name": "openai",
  • "model_name": "string",
  • "properties": {
    },
  • "model_type": "string"
}

Create Vector Store Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

The description of the vector store config

store_type
required
string (VectorStoreType)
Enum: "lancedb_fts" "lancedb_hybrid" "lancedb_vector"

The type of vector store to use

required
LanceDBConfigFTSPropertiesPublic (object) or LanceDBConfigVectorPropertiesPublic (object) or LanceDBConfigHybridPropertiesPublic (object) (Properties)

The properties of the vector store config, specific to the selected store_type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "store_type": "lancedb_fts",
  • "properties": {
    }
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "description": "string",
  • "store_type": "lancedb_fts",
  • "properties": {
    },
  • "model_type": "string"
}

Get Vector Store Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Rag Config

path Parameters
project_id
required
string (Project Id)
rag_config_id
required
string (Rag Config Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Is Archived (boolean) or Is Archived (null) (Is Archived)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_archived": true
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "is_archived": false,
  • "description": "string",
  • "tool_name": "string",
  • "tool_description": "string",
  • "extractor_config_id": "string",
  • "chunker_config_id": "string",
  • "embedding_config_id": "string",
  • "vector_store_config_id": "string",
  • "reranker_config_id": "string",
  • "tags": [
    ],
  • "model_type": "string"
}

Get Rag Config

path Parameters
project_id
required
string (Project Id)
rag_config_id
required
string (Rag Config Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "tool_name": "string",
  • "tool_description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "is_archived": true,
  • "extractor_config": {
    },
  • "chunker_config": {
    },
  • "embedding_config": {
    },
  • "vector_store_config": {
    },
  • "reranker_config": {
    },
  • "tags": [
    ]
}

Create Rag Config

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

A name for this entity.

Description (string) or Description (null) (Description)

A description for your own reference.

tool_name
required
string (Tool Name)

A name for the model to identify the Search Tool in conversations.

tool_description
required
string (Tool Description)

A description of the purpose of the tool. The model will use this description to understand the tool's capabilities.

required
Extractor Config Id (string) or Extractor Config Id (null) (Extractor Config Id)

The extractor config to use for the RAG workflow

required
Chunker Config Id (string) or Chunker Config Id (null) (Chunker Config Id)

The chunker config to use for the RAG workflow.

required
Embedding Config Id (string) or Embedding Config Id (null) (Embedding Config Id)

The embedding config to use for the RAG workflow.

required
Vector Store Config Id (string) or Vector Store Config Id (null) (Vector Store Config Id)

The vector store config to use for the RAG workflow.

Reranker Config Id (string) or Reranker Config Id (null) (Reranker Config Id)

The reranker config to use for the RAG workflow.

Array of Tags (strings) or Tags (null) (Tags)

List of document tags to filter by. If None, all documents in the project are used.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "tool_name": "string",
  • "tool_description": "string",
  • "extractor_config_id": "string",
  • "chunker_config_id": "string",
  • "embedding_config_id": "string",
  • "vector_store_config_id": "string",
  • "reranker_config_id": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "v": 1,
  • "id": "string",
  • "path": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "name": "string",
  • "is_archived": false,
  • "description": "string",
  • "tool_name": "string",
  • "tool_description": "string",
  • "extractor_config_id": "string",
  • "chunker_config_id": "string",
  • "embedding_config_id": "string",
  • "vector_store_config_id": "string",
  • "reranker_config_id": "string",
  • "tags": [
    ],
  • "model_type": "string"
}

Get Rag Configs

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Run Rag Config

path Parameters
project_id
required
string (Project Id)
rag_config_id
required
string (Rag Config Id)

Responses

Response samples

Content type
application/json
null

Get Rag Config Progress

path Parameters
project_id
required
string (Project Id)
Request Body schema: application/json
required
Array of Rag Config Ids (strings) or Rag Config Ids (null) (Rag Config Ids)

The RAG config ids to get progress for, if left empty, progress for all RAG configs in the project will be returned

Responses

Request samples

Content type
application/json
{
  • "rag_config_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Search Rag Config

Search the vector store associated with a RAG config.

path Parameters
project_id
required
string (Project Id)
rag_config_id
required
string (Rag Config Id)
Request Body schema: application/json
required
query
required
string (Query)

The search query text

Responses

Request samples

Content type
application/json
{
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Check Library State

path Parameters
project_id
required
string (Project Id)

Responses

Response samples

Content type
application/json
{
  • "is_empty": true
}

Ephemeral Split Document

Return chunks for a document extraction using FixedWindowChunker without persisting.

If chunk_size is None, return a single chunk with the full extraction output. chunk_overlap defaults to 0 when not provided.

path Parameters
project_id
required
string (Project Id)
extractor_config_id
required
string (Extractor Config Id)
document_id
required
string (Document Id)
Request Body schema: application/json
required
Chunk Size (integer) or Chunk Size (null) (Chunk Size)

The size of each chunk in tokens. If None, return a single chunk with the full extraction output.

Chunk Overlap (integer) or Chunk Overlap (null) (Chunk Overlap)

The overlap between chunks in tokens. If None, use the default overlap for the chunker.

Responses

Request samples

Content type
application/json
{
  • "chunk_size": 0,
  • "chunk_overlap": 0
}

Response samples

Content type
application/json
{
  • "chunks": [
    ]
}