Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Projects

Archive project
Project admin().organization().projects().archive(params = ProjectArchiveParams.none(), requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/archive
Create project
Project admin().organization().projects().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects
List projects
ProjectListPage admin().organization().projects().list(params = ProjectListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects
Retrieve project
Project admin().organization().projects().retrieve(params = ProjectRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}
Modify project
Project admin().organization().projects().update(params = ProjectUpdateParams.none(), requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}
Models
class Project:

Represents an individual project.

enum ProjectResidency:

ProjectsAPI Keys

Delete project API key
ApiKeyDeleteResponse admin().organization().projects().apiKeys().delete(params, requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/api_keys/{api_key_id}
List project API keys
ApiKeyListPage admin().organization().projects().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/api_keys
Retrieve project API key
ProjectApiKey admin().organization().projects().apiKeys().retrieve(params, requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/api_keys/{api_key_id}
Update project API key
ProjectApiKey admin().organization().projects().apiKeys().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/api_keys/{api_key_id}
Models
class ProjectApiKey:

Represents an individual API key in a project.

ProjectsCertificates

Activate certificates for project
CertificateActivatePage admin().organization().projects().certificates().activate(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/certificates/activate
Deactivate certificates for project
CertificateDeactivatePage admin().organization().projects().certificates().deactivate(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/certificates/deactivate
List project certificates
CertificateListPage admin().organization().projects().certificates().list(params = CertificateListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/certificates

ProjectsData Retention

Retrieve project data retention
ProjectDataRetention admin().organization().projects().dataRetention().retrieve(params = DataRetentionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/data_retention
Update project data retention
ProjectDataRetention admin().organization().projects().dataRetention().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/data_retention
Models
class ProjectDataRetention:

Represents a project’s data retention control setting.

ProjectsGroups

Add project group
ProjectGroup admin().organization().projects().groups().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/groups
Remove project group
GroupDeleteResponse admin().organization().projects().groups().delete(params, requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/groups/{group_id}
List project groups
GroupListPage admin().organization().projects().groups().list(params = GroupListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/groups
Retrieve project group
ProjectGroup admin().organization().projects().groups().retrieve(params, requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/groups/{group_id}
Models
class ProjectGroup:

Details about a group’s membership in a project.

ProjectsGroupsRoles

Assign project role to group
RoleCreateResponse admin().organization().projects().groups().roles().create(params, requestOptions = RequestOptions.none())
POST
/projects/{project_id}/groups/{group_id}/roles
Unassign project role from group
RoleDeleteResponse admin().organization().projects().groups().roles().delete(params, requestOptions = RequestOptions.none())
DELETE
/projects/{project_id}/groups/{group_id}/roles/{role_id}
List project group role assignments
RoleListPage admin().organization().projects().groups().roles().list(params, requestOptions = RequestOptions.none())
GET
/projects/{project_id}/groups/{group_id}/roles
Retrieve project group role
RoleRetrieveResponse admin().organization().projects().groups().roles().retrieve(params, requestOptions = RequestOptions.none())
GET
/projects/{project_id}/groups/{group_id}/roles/{role_id}

ProjectsHosted Tool Permissions

Retrieve project hosted tool permissions
ProjectHostedToolPermissions admin().organization().projects().hostedToolPermissions().retrieve(params = HostedToolPermissionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/hosted_tool_permissions
Modify project hosted tool permissions
ProjectHostedToolPermissions admin().organization().projects().hostedToolPermissions().update(params = HostedToolPermissionUpdateParams.none(), requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/hosted_tool_permissions
Models
class ProjectHostedToolPermissions:

Represents hosted tool permissions for a project.

ProjectsModel Permissions

Delete project model permissions
ProjectModelPermissionsDeleted admin().organization().projects().modelPermissions().delete(params = ModelPermissionDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/model_permissions
Retrieve project model permissions
ProjectModelPermissions admin().organization().projects().modelPermissions().retrieve(params = ModelPermissionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/model_permissions
Modify project model permissions
ProjectModelPermissions admin().organization().projects().modelPermissions().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/model_permissions
Models
class ProjectModelPermissions:

Represents the model allowlist or denylist policy for a project.

class ProjectModelPermissionsDeleted:

Confirmation payload returned after deleting project model permissions.

ProjectsRate Limits

List project rate limits
RateLimitListRateLimitsPage admin().organization().projects().rateLimits().listRateLimits(params = RateLimitListRateLimitsParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/rate_limits
Modify project rate limit
ProjectRateLimit admin().organization().projects().rateLimits().updateRateLimit(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/rate_limits/{rate_limit_id}
Models
class ProjectRateLimit:

Represents a project rate limit config.

ProjectsRoles

Create project role
Role admin().organization().projects().roles().create(params, requestOptions = RequestOptions.none())
POST
/projects/{project_id}/roles
Delete project role
RoleDeleteResponse admin().organization().projects().roles().delete(params, requestOptions = RequestOptions.none())
DELETE
/projects/{project_id}/roles/{role_id}
List project roles
RoleListPage admin().organization().projects().roles().list(params = RoleListParams.none(), requestOptions = RequestOptions.none())
GET
/projects/{project_id}/roles
Retrieve project role
Role admin().organization().projects().roles().retrieve(params, requestOptions = RequestOptions.none())
GET
/projects/{project_id}/roles/{role_id}
Update project role
Role admin().organization().projects().roles().update(params, requestOptions = RequestOptions.none())
POST
/projects/{project_id}/roles/{role_id}

ProjectsService Accounts

Create project service account
ServiceAccountCreateResponse admin().organization().projects().serviceAccounts().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/service_accounts
Delete project service account
ServiceAccountDeleteResponse admin().organization().projects().serviceAccounts().delete(params, requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/service_accounts/{service_account_id}
List project service accounts
ServiceAccountListPage admin().organization().projects().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/service_accounts
Retrieve project service account
ProjectServiceAccount admin().organization().projects().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/service_accounts/{service_account_id}
Update project service account
ProjectServiceAccount admin().organization().projects().serviceAccounts().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}
Models
class ProjectServiceAccount:

Represents an individual service account in a project.

ProjectsService AccountsAPI Keys

Create an API key for a service account
ApiKeyCreateResponse admin().organization().projects().serviceAccounts().apiKeys().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys

ProjectsSpend Alerts

Create project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/spend_alerts
Delete project spend alert
ProjectSpendAlertDeleted admin().organization().projects().spendAlerts().delete(params, requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/spend_alerts/{alert_id}
List project spend alerts
SpendAlertListPage admin().organization().projects().spendAlerts().list(params = SpendAlertListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/spend_alerts
Retrieve project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().retrieve(params, requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/spend_alerts/{alert_id}
Update project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/spend_alerts/{alert_id}
Models
class ProjectSpendAlert:

Represents a spend alert configured at the project level.

class ProjectSpendAlertDeleted:

Confirmation payload returned after deleting a project spend alert.

ProjectsSpend Limit

Delete project spend limit
ProjectSpendLimitDeleted admin().organization().projects().spendLimit().delete(params = SpendLimitDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/spend_limit
Get project spend limit
ProjectSpendLimit admin().organization().projects().spendLimit().retrieve(params = SpendLimitRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/spend_limit
Update project spend limit
ProjectSpendLimit admin().organization().projects().spendLimit().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/spend_limit
Models
class ProjectSpendLimit:

Represents a hard spend limit configured at the project level.

class ProjectSpendLimitDeleted:

Confirmation payload returned after deleting a project hard spend limit.

ProjectsUsers

Create project user
ProjectUser admin().organization().projects().users().create(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/users
Delete project user
UserDeleteResponse admin().organization().projects().users().delete(params, requestOptions = RequestOptions.none())
DELETE
/organization/projects/{project_id}/users/{user_id}
List project users
UserListPage admin().organization().projects().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/users
Retrieve project user
ProjectUser admin().organization().projects().users().retrieve(params, requestOptions = RequestOptions.none())
GET
/organization/projects/{project_id}/users/{user_id}
Modify project user
ProjectUser admin().organization().projects().users().update(params, requestOptions = RequestOptions.none())
POST
/organization/projects/{project_id}/users/{user_id}
Models
class ProjectUser:

Represents an individual user in a project.

ProjectsUsersRoles

Assign project role to user
RoleCreateResponse admin().organization().projects().users().roles().create(params, requestOptions = RequestOptions.none())
POST
/projects/{project_id}/users/{user_id}/roles
Unassign project role from user
RoleDeleteResponse admin().organization().projects().users().roles().delete(params, requestOptions = RequestOptions.none())
DELETE
/projects/{project_id}/users/{user_id}/roles/{role_id}
List project user role assignments
RoleListPage admin().organization().projects().users().roles().list(params, requestOptions = RequestOptions.none())
GET
/projects/{project_id}/users/{user_id}/roles
Retrieve project user role
RoleRetrieveResponse admin().organization().projects().users().roles().retrieve(params, requestOptions = RequestOptions.none())
GET
/projects/{project_id}/users/{user_id}/roles/{role_id}