Skip to navigation

Create Project

Create a project, optionally with its own routing policy and a spending budget. Without a routing policy, the project routes with the organization's default.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Request

This endpoint expects an object.
namestringRequired<=255 characters
The project's name.
budget_configobject or nullOptional
A spending budget for the project.
descriptionstring or nullOptional
What the project is for.
routing_policyobject or nullOptional

The project’s own routing policy. Send it with uses_organization_default_routing false.

uses_organization_default_routingbooleanOptionalDefaults to true

true routes the project with the organization’s default policy. false needs routing_policy, which becomes the project’s own policy.

Response

The created project
budget_configobject or null

The project’s spending budget; null when it has none.

created_atdatetimeRead-only
When the project was created.
descriptionstring or null
What the project is for.
idstringRead-onlyformat: "uuid"
The project's id.
is_activeboolean
false while the project's prompt injection, DLP and controls overrides are switched off.
namestring
The project's name.
organization_idstringRead-onlyformat: "uuid"
The organization the project belongs to.
routing_policyobject or null

The project’s own routing policy; null when it uses the organization default.

slugstringRead-only
Derived from the name at creation and unique in the organization. It doesn't change when the project is renamed.
updated_atdatetimeRead-only
When the project last changed.
uses_organization_default_routingboolean
true when the project routes with the organization's default policy, having no policy of its own.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
502
Bad Gateway Error