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

Organization

OrganizationAdmin API Keys

Create admin API key
AdminApiKeyCreateResponse admin().organization().adminApiKeys().create(AdminApiKeyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/admin_api_keys
Delete admin API key
AdminApiKeyDeleteResponse admin().organization().adminApiKeys().delete(AdminApiKeyDeleteParamsparams = AdminApiKeyDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/admin_api_keys/{key_id}
List all organization and project API keys.
AdminApiKeyListPage admin().organization().adminApiKeys().list(AdminApiKeyListParamsparams = AdminApiKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/admin_api_keys
Retrieve admin API key
AdminApiKey admin().organization().adminApiKeys().retrieve(AdminApiKeyRetrieveParamsparams = AdminApiKeyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/admin_api_keys/{key_id}
ModelsExpand Collapse
class AdminApiKey:

Represents an individual Admin API key in an org.

OrganizationAudit Logs

List user actions and configuration changes within this organization.

List audit logs
AuditLogListPage admin().organization().auditLogs().list(AuditLogListParamsparams = AuditLogListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/audit_logs

OrganizationCertificates

Activate certificates for organization
CertificateActivatePage admin().organization().certificates().activate(CertificateActivateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/certificates/activate
Upload certificate
Certificate admin().organization().certificates().create(CertificateCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/certificates
Deactivate certificates for organization
CertificateDeactivatePage admin().organization().certificates().deactivate(CertificateDeactivateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/certificates/deactivate
Delete certificate
CertificateDeleteResponse admin().organization().certificates().delete(CertificateDeleteParamsparams = CertificateDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/certificates/{certificate_id}
List organization certificates
CertificateListPage admin().organization().certificates().list(CertificateListParamsparams = CertificateListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/certificates
Get certificate
Certificate admin().organization().certificates().retrieve(CertificateRetrieveParamsparams = CertificateRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/certificates/{certificate_id}
Modify certificate
Certificate admin().organization().certificates().update(CertificateUpdateParamsparams = CertificateUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/certificates/{certificate_id}
ModelsExpand Collapse
class Certificate:

Represents an individual certificate uploaded to the organization.

OrganizationData Retention

Retrieve organization data retention
OrganizationDataRetention admin().organization().dataRetention().retrieve(DataRetentionRetrieveParamsparams = DataRetentionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/data_retention
Update organization data retention
OrganizationDataRetention admin().organization().dataRetention().update(DataRetentionUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/data_retention
ModelsExpand Collapse
class OrganizationDataRetention:

Represents the organization’s data retention control setting.

OrganizationGroups

Create group
Group admin().organization().groups().create(GroupCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/groups
Delete group
GroupDeleteResponse admin().organization().groups().delete(GroupDeleteParamsparams = GroupDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/groups/{group_id}
List groups
GroupListPage admin().organization().groups().list(GroupListParamsparams = GroupListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups
Retrieve group
Group admin().organization().groups().retrieve(GroupRetrieveParamsparams = GroupRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups/{group_id}
Update group
GroupUpdateResponse admin().organization().groups().update(GroupUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/groups/{group_id}
ModelsExpand Collapse
class Group:

Details about an organization group.

OrganizationGroupsRoles

Assign organization role to group
RoleCreateResponse admin().organization().groups().roles().create(RoleCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/groups/{group_id}/roles
Unassign organization role from group
RoleDeleteResponse admin().organization().groups().roles().delete(RoleDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/groups/{group_id}/roles/{role_id}
List group organization role assignments
RoleListPage admin().organization().groups().roles().list(RoleListParamsparams = RoleListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups/{group_id}/roles
Retrieve group organization role
RoleRetrieveResponse admin().organization().groups().roles().retrieve(RoleRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups/{group_id}/roles/{role_id}

OrganizationGroupsUsers

Add group user
UserCreateResponse admin().organization().groups().users().create(UserCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/groups/{group_id}/users
Remove group user
UserDeleteResponse admin().organization().groups().users().delete(UserDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/groups/{group_id}/users/{user_id}
List group users
UserListPage admin().organization().groups().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups/{group_id}/users
Retrieve group user
UserRetrieveResponse admin().organization().groups().users().retrieve(UserRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/groups/{group_id}/users/{user_id}
ModelsExpand Collapse
class OrganizationGroupUser:

Represents an individual user returned when inspecting group membership.

OrganizationInvites

Create invite
Invite admin().organization().invites().create(InviteCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/invites
Delete invite
InviteDeleteResponse admin().organization().invites().delete(InviteDeleteParamsparams = InviteDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/invites/{invite_id}
List invites
InviteListPage admin().organization().invites().list(InviteListParamsparams = InviteListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/invites
Retrieve invite
Invite admin().organization().invites().retrieve(InviteRetrieveParamsparams = InviteRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/invites/{invite_id}
ModelsExpand Collapse
class Invite:

Represents an individual invite to the organization.

OrganizationProjects

Archive project
Project admin().organization().projects().archive(ProjectArchiveParamsparams = ProjectArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/archive
Create project
Project admin().organization().projects().create(ProjectCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects
List projects
ProjectListPage admin().organization().projects().list(ProjectListParamsparams = ProjectListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects
Retrieve project
Project admin().organization().projects().retrieve(ProjectRetrieveParamsparams = ProjectRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}
Modify project
Project admin().organization().projects().update(ProjectUpdateParamsparams = ProjectUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}
ModelsExpand Collapse
class Project:

Represents an individual project.

OrganizationProjectsAPI Keys

Delete project API key
ApiKeyDeleteResponse admin().organization().projects().apiKeys().delete(ApiKeyDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/api_keys/{api_key_id}
List project API keys
ApiKeyListPage admin().organization().projects().apiKeys().list(ApiKeyListParamsparams = ApiKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/api_keys
Retrieve project API key
ProjectApiKey admin().organization().projects().apiKeys().retrieve(ApiKeyRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/api_keys/{api_key_id}
ModelsExpand Collapse
class ProjectApiKey:

Represents an individual API key in a project.

OrganizationProjectsCertificates

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

OrganizationProjectsData Retention

Retrieve project data retention
ProjectDataRetention admin().organization().projects().dataRetention().retrieve(DataRetentionRetrieveParamsparams = DataRetentionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/data_retention
Update project data retention
ProjectDataRetention admin().organization().projects().dataRetention().update(DataRetentionUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/data_retention
ModelsExpand Collapse
class ProjectDataRetention:

Represents a project’s data retention control setting.

OrganizationProjectsGroups

Add project group
ProjectGroup admin().organization().projects().groups().create(GroupCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/groups
Remove project group
GroupDeleteResponse admin().organization().projects().groups().delete(GroupDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/groups/{group_id}
List project groups
GroupListPage admin().organization().projects().groups().list(GroupListParamsparams = GroupListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/groups
Retrieve project group
ProjectGroup admin().organization().projects().groups().retrieve(GroupRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/groups/{group_id}
ModelsExpand Collapse
class ProjectGroup:

Details about a group’s membership in a project.

OrganizationProjectsGroupsRoles

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

OrganizationProjectsHosted Tool Permissions

Retrieve project hosted tool permissions
ProjectHostedToolPermissions admin().organization().projects().hostedToolPermissions().retrieve(HostedToolPermissionRetrieveParamsparams = HostedToolPermissionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/hosted_tool_permissions
Modify project hosted tool permissions
ProjectHostedToolPermissions admin().organization().projects().hostedToolPermissions().update(HostedToolPermissionUpdateParamsparams = HostedToolPermissionUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/hosted_tool_permissions
ModelsExpand Collapse
class ProjectHostedToolPermissions:

Represents hosted tool permissions for a project.

OrganizationProjectsModel Permissions

Delete project model permissions
ProjectModelPermissionsDeleted admin().organization().projects().modelPermissions().delete(ModelPermissionDeleteParamsparams = ModelPermissionDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/model_permissions
Retrieve project model permissions
ProjectModelPermissions admin().organization().projects().modelPermissions().retrieve(ModelPermissionRetrieveParamsparams = ModelPermissionRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/model_permissions
Modify project model permissions
ProjectModelPermissions admin().organization().projects().modelPermissions().update(ModelPermissionUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/model_permissions
ModelsExpand Collapse
class ProjectModelPermissions:

Represents the model allowlist or denylist policy for a project.

class ProjectModelPermissionsDeleted:

Confirmation payload returned after deleting project model permissions.

OrganizationProjectsRate Limits

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

Represents a project rate limit config.

OrganizationProjectsRoles

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

OrganizationProjectsService Accounts

Create project service account
ServiceAccountCreateResponse admin().organization().projects().serviceAccounts().create(ServiceAccountCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/service_accounts
Delete project service account
ServiceAccountDeleteResponse admin().organization().projects().serviceAccounts().delete(ServiceAccountDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/service_accounts/{service_account_id}
List project service accounts
ServiceAccountListPage admin().organization().projects().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/service_accounts
Retrieve project service account
ProjectServiceAccount admin().organization().projects().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/service_accounts/{service_account_id}
Update project service account
ProjectServiceAccount admin().organization().projects().serviceAccounts().update(ServiceAccountUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/service_accounts/{service_account_id}
ModelsExpand Collapse
class ProjectServiceAccount:

Represents an individual service account in a project.

OrganizationProjectsService AccountsAPI Keys

Create project service account API key
ApiKeyCreateResponse admin().organization().projects().serviceAccounts().apiKeys().create(ApiKeyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys

OrganizationProjectsSpend Alerts

Create project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().create(SpendAlertCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/spend_alerts
Delete project spend alert
ProjectSpendAlertDeleted admin().organization().projects().spendAlerts().delete(SpendAlertDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/spend_alerts/{alert_id}
List project spend alerts
SpendAlertListPage admin().organization().projects().spendAlerts().list(SpendAlertListParamsparams = SpendAlertListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/spend_alerts
Retrieve project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().retrieve(SpendAlertRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/spend_alerts/{alert_id}
Update project spend alert
ProjectSpendAlert admin().organization().projects().spendAlerts().update(SpendAlertUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/spend_alerts/{alert_id}
ModelsExpand Collapse
class ProjectSpendAlert:

Represents a spend alert configured at the project level.

class ProjectSpendAlertDeleted:

Confirmation payload returned after deleting a project spend alert.

OrganizationProjectsSpend Limit

Delete project spend limit
ProjectSpendLimitDeleted admin().organization().projects().spendLimit().delete(SpendLimitDeleteParamsparams = SpendLimitDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/spend_limit
Retrieve project spend limit
ProjectSpendLimit admin().organization().projects().spendLimit().retrieve(SpendLimitRetrieveParamsparams = SpendLimitRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/spend_limit
Update project spend limit
ProjectSpendLimit admin().organization().projects().spendLimit().update(SpendLimitUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/spend_limit
ModelsExpand Collapse
class ProjectSpendLimit:

Represents a hard spend limit configured at the project level.

class ProjectSpendLimitDeleted:

Confirmation payload returned after deleting a project hard spend limit.

OrganizationProjectsUsers

Create project user
ProjectUser admin().organization().projects().users().create(UserCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/users
Delete project user
UserDeleteResponse admin().organization().projects().users().delete(UserDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/projects/{project_id}/users/{user_id}
List project users
UserListPage admin().organization().projects().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/users
Retrieve project user
ProjectUser admin().organization().projects().users().retrieve(UserRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/projects/{project_id}/users/{user_id}
Modify project user
ProjectUser admin().organization().projects().users().update(UserUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/projects/{project_id}/users/{user_id}
ModelsExpand Collapse
class ProjectUser:

Represents an individual user in a project.

OrganizationProjectsUsersRoles

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

OrganizationRoles

Create organization role
Role admin().organization().roles().create(RoleCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/roles
Delete organization role
RoleDeleteResponse admin().organization().roles().delete(RoleDeleteParamsparams = RoleDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/roles/{role_id}
List organization roles
RoleListPage admin().organization().roles().list(RoleListParamsparams = RoleListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/roles
Retrieve organization role
Role admin().organization().roles().retrieve(RoleRetrieveParamsparams = RoleRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/roles/{role_id}
Update organization role
Role admin().organization().roles().update(RoleUpdateParamsparams = RoleUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/roles/{role_id}
ModelsExpand Collapse
class Role:

Details about a role that can be assigned through the public Roles API.

OrganizationSpend Alerts

Create organization spend alert
OrganizationSpendAlert admin().organization().spendAlerts().create(SpendAlertCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/spend_alerts
Delete organization spend alert
OrganizationSpendAlertDeleted admin().organization().spendAlerts().delete(SpendAlertDeleteParamsparams = SpendAlertDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/spend_alerts/{alert_id}
List organization spend alerts
SpendAlertListPage admin().organization().spendAlerts().list(SpendAlertListParamsparams = SpendAlertListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/spend_alerts
Retrieve organization spend alert
OrganizationSpendAlert admin().organization().spendAlerts().retrieve(SpendAlertRetrieveParamsparams = SpendAlertRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/spend_alerts/{alert_id}
Update organization spend alert
OrganizationSpendAlert admin().organization().spendAlerts().update(SpendAlertUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/spend_alerts/{alert_id}
ModelsExpand Collapse
class OrganizationSpendAlert:

Represents a spend alert configured at the organization level.

class OrganizationSpendAlertDeleted:

Confirmation payload returned after deleting an organization spend alert.

OrganizationSpend Limit

Delete organization spend limit
OrganizationSpendLimitDeleted admin().organization().spendLimit().delete(SpendLimitDeleteParamsparams = SpendLimitDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/spend_limit
Retrieve organization spend limit
OrganizationSpendLimit admin().organization().spendLimit().retrieve(SpendLimitRetrieveParamsparams = SpendLimitRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/spend_limit
Update organization spend limit
OrganizationSpendLimit admin().organization().spendLimit().update(SpendLimitUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/spend_limit
ModelsExpand Collapse
class OrganizationSpendLimit:

Represents a hard spend limit configured at the organization level.

class OrganizationSpendLimitDeleted:

Confirmation payload returned after deleting an organization hard spend limit.

OrganizationUsage

Audio speeches
UsageAudioSpeechesResponse admin().organization().usage().audioSpeeches(UsageAudioSpeechesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/audio_speeches
Audio transcriptions
UsageAudioTranscriptionsResponse admin().organization().usage().audioTranscriptions(UsageAudioTranscriptionsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/audio_transcriptions
Code interpreter sessions
UsageCodeInterpreterSessionsResponse admin().organization().usage().codeInterpreterSessions(UsageCodeInterpreterSessionsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/code_interpreter_sessions
Completions
UsageCompletionsResponse admin().organization().usage().completions(UsageCompletionsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/completions
Costs
UsageCostsResponse admin().organization().usage().costs(UsageCostsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/costs
Embeddings
UsageEmbeddingsResponse admin().organization().usage().embeddings(UsageEmbeddingsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/embeddings
File search calls
UsageFileSearchCallsResponse admin().organization().usage().fileSearchCalls(UsageFileSearchCallsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/file_search_calls
Images
UsageImagesResponse admin().organization().usage().images(UsageImagesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/images
Moderations
UsageModerationsResponse admin().organization().usage().moderations(UsageModerationsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/moderations
Vector stores
UsageVectorStoresResponse admin().organization().usage().vectorStores(UsageVectorStoresParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/vector_stores
Web search calls
UsageWebSearchCallsResponse admin().organization().usage().webSearchCalls(UsageWebSearchCallsParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/usage/web_search_calls

OrganizationUsers

Delete user
UserDeleteResponse admin().organization().users().delete(UserDeleteParamsparams = UserDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/users/{user_id}
List users
UserListPage admin().organization().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/users
Retrieve user
OrganizationUser admin().organization().users().retrieve(UserRetrieveParamsparams = UserRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/users/{user_id}
Modify user
OrganizationUser admin().organization().users().update(UserUpdateParamsparams = UserUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/users/{user_id}
ModelsExpand Collapse
class OrganizationUser:

Represents an individual user within an organization.

OrganizationUsersRoles

Assign organization role to user
RoleCreateResponse admin().organization().users().roles().create(RoleCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/organization/users/{user_id}/roles
Unassign organization role from user
RoleDeleteResponse admin().organization().users().roles().delete(RoleDeleteParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/users/{user_id}/roles/{role_id}
List user organization role assignments
RoleListPage admin().organization().users().roles().list(RoleListParamsparams = RoleListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/users/{user_id}/roles
Retrieve user organization role
RoleRetrieveResponse admin().organization().users().roles().retrieve(RoleRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/organization/users/{user_id}/roles/{role_id}