DocsAPI ReferenceProjects API Projects API
CRUD operations for managing projects. All endpoints require authentication.
List all projects for the authenticated user.
Response
[
{
"id": "uuid",
"name": "My Research Project",
"user_id": "clerk_user_id",
"created_at": "2025-01-01T00:00:00Z"
}
]
Create a new project.
Request Body
| Parameter | Type | Description |
|---|
| name required | string | Name for the new project |
Response
{
"id": "uuid",
"name": "My New Project",
"user_id": "clerk_user_id",
"created_at": "2025-01-01T00:00:00Z"
}
Delete a project and all associated data (documents, chunks, chats, messages).
Path Parameters
| Parameter | Type | Description |
|---|
| project_id required | uuid | ID of the project to delete |
Response
Returns 204 No Content on success.
Get the RAG settings for a project.
Response
{
"rag_strategy": "basic",
"agent_type": "simple",
"embedding_model": "text-embedding-3-large",
"num_chunks": 5,
"final_context_size": 5,
"similarity_threshold": 0.3,
"use_reranking": false,
"multi_query_count": 3,
"vector_weight": 0.7,
"keyword_weight": 0.3
}
Update RAG settings for a project.
Request Body
| Parameter | Type | Description |
|---|
| rag_strategy | string | One of: basic, hybrid, multi_query_vector, multi_query_hybrid |
| agent_type | string | One of: simple, agentic |
| num_chunks | integer | Number of chunks to retrieve (1–20) |
| similarity_threshold | float | Minimum similarity score (0.0–1.0) |
| use_reranking | boolean | Enable/disable cross-encoder reranking |
