Projects
Workspaces contain
Project objects. Jobs and catalog usage always belong to exactly one project. Use a workspace API key (sk_wsp_…) to list, create, and manage projects. Optionally set creditLimit to cap how many credits this project may consume each billing period; omit for no project ceiling (shared workspace pool only). Each project can use the platform vector store or a bring-your-own Qdrant cluster — see Vector store.The Project object
- projectIdstring
- Stable project identifier (prj_…).
- workspaceIdstring
- Owning workspace.
- namestring
- Display name (1–120 characters).
- descriptionstring, optional
- Optional note (up to 500 characters).
- creditLimitinteger | null, optional
- Optional monthly credit cap for this project (positive integer). Null = no project cap.
- createdAttimestamp
- Creation time.
List projects
GET
/v1/projectsLists all projects in the workspace.
Requires permission
project:list
Create a project
POST
/v1/projectsCreates a new project. Pass
creditLimit to set an initial monthly credit cap (must be ≤ the workspace pool when the workspace is capped).Requires permission
project:create
Parameters
- namestring
- Project name.
- descriptionstring, optional
- Optional description.
- creditLimitinteger | null, optional
- Optional monthly credit cap. Omit for no project cap.
Retrieve a project
GET
/v1/projects/{projectId}Returns one project by ID.
Requires permission
project:read
Update a project
PATCH
/v1/projects/{projectId}Updates name, description, and/or
creditLimit. Set creditLimit to null to remove the project cap.Requires permission
project:update
Parameters
- namestring, optional
- New name.
- descriptionstring, optional
- New description.
- creditLimitinteger | null, optional
- New monthly credit cap; null clears the cap.
Retrieve project usage
GET
/v1/projects/{projectId}/usageReturns this project's consumption for the current billing period. Top-level
used, remaining, and creditLimit reflect the unified credit pool for this project. byService[] lists action units per service; multiply by creditCosts from GET /v1/billing/limits for credits charged. byApiKey attributes usage to console or named API keys.Requires permission
project:read