Skip to main content
POST
/
api
/
v2
/
projects
{
  "org_id": "<string>",
  "project_id": "<string>",
  "description": "",
  "config": {
    "reranker": "",
    "embedder": ""
  }
}

Body

application/json

Specification model for creating a new project.

A project belongs to an organization and has its own identifiers, description, and configuration. The project ID must be unique within the organization.

org_id
string
required
The unique identifier of the organization.

- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, and Unicode
characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
are allowed.

This value determines the namespace the project belongs to.
project_id
string
required
The identifier of the project.

- Must be unique within the organization.
- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, and Unicode
characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
are allowed.

This ID is used in API paths and resource locations.
description
string
default:""
A human-readable description of the project.
Used for display purposes in UIs and dashboards.
Optional; defaults to an empty string.
config
ProjectConfig · object
Configuration settings associated with this project.

Defines which models (reranker, embedder) to use. If any values within
`ProjectConfig` are empty, global defaults are applied.

Response

Successful Response

Response model returned after project operations (e.g., creation, update, fetch).

Contains the resolved identifiers and configuration of the project as stored in the system. Field formats follow the same validation rules as in CreateProjectSpec.

org_id
string
required
The unique identifier of the organization this project belongs to.

Returned exactly as stored by the system.
project_id
string
required
The identifier of the project.

This value uniquely identifies the project within the organization.
description
string
default:""
A human-readable description of the project.
Used for display purposes in UIs and dashboards.
Optional; defaults to an empty string.
config
ProjectConfig · object
Configuration settings associated with this project.

Defines which models (reranker, embedder) to use. If any values within
`ProjectConfig` are empty, global defaults are applied.