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 serviceLimits per service to allocate part of the workspace monthly allowance to a project; omitted services have no project cap and draw from the shared workspace pool. 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).
- serviceLimitsobject, optional
- Optional per-service monthly caps (positive integers). Omitted services are uncapped at the project level.
- 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
serviceLimits to set initial per-service caps (each must be ≤ the workspace limit for that service).Requires permission
project:create
Parameters
- namestring
- Project name.
- descriptionstring, optional
- Optional description.
- serviceLimitsobject, optional
- Optional map of service → monthly cap (e.g. transcription: 5). Omit for no project caps.
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
serviceLimits. Set a service to null in serviceLimits to remove that cap.Requires permission
project:update
Parameters
- namestring, optional
- New name.
- descriptionstring, optional
- New description.
- serviceLimitsobject, optional
- Partial map of caps; null clears a service cap.
Retrieve project usage
GET
/v1/projects/{projectId}/usageReturns this project's consumption for the current billing period.
services[] has used, limit, and remaining per service (limit is the project cap when set, or null for the shared workspace pool). byApiKey attributes credits to console or named API keys.Requires permission
project:read