API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Organization

OrganizationAdmin API Keys

Create admin API key

admin.organization.admin_api_keys.create(AdminAPIKeyCreateParams**kwargs) -> AdminAPIKeyCreateResponse

POST/organization/admin_api_keys

Delete admin API key

admin.organization.admin_api_keys.delete(strkey_id) -> AdminAPIKeyDeleteResponse

DELETE/organization/admin_api_keys/{key_id}

List all organization and project API keys.

admin.organization.admin_api_keys.list(AdminAPIKeyListParams**kwargs) -> SyncCursorPage[AdminAPIKey]

GET/organization/admin_api_keys

Retrieve admin API key

admin.organization.admin_api_keys.retrieve(strkey_id) -> AdminAPIKey

GET/organization/admin_api_keys/{key_id}

ModelsExpand Collapse

class AdminAPIKey: …

Represents an individual Admin API key in an org.

class AdminAPIKeyCreateResponse: …

Represents an individual Admin API key in an org.

class AdminAPIKeyDeleteResponse: …

OrganizationAudit Logs

List user actions and configuration changes within this organization.

List audit logs

admin.organization.audit_logs.list(AuditLogListParams**kwargs) -> SyncConversationCursorPage[AuditLogListResponse]

GET/organization/audit_logs

ModelsExpand Collapse

class AuditLogListResponse: …

A log of a user action or configuration change within this organization.

OrganizationCertificates

Activate certificates for organization

admin.organization.certificates.activate(CertificateActivateParams**kwargs) -> SyncPage[CertificateActivateResponse]

POST/organization/certificates/activate

Upload certificate

admin.organization.certificates.create(CertificateCreateParams**kwargs) -> Certificate

POST/organization/certificates

Deactivate certificates for organization

admin.organization.certificates.deactivate(CertificateDeactivateParams**kwargs) -> SyncPage[CertificateDeactivateResponse]

POST/organization/certificates/deactivate

Delete certificate

admin.organization.certificates.delete(strcertificate_id) -> CertificateDeleteResponse

DELETE/organization/certificates/{certificate_id}

List organization certificates

admin.organization.certificates.list(CertificateListParams**kwargs) -> SyncConversationCursorPage[CertificateListResponse]

GET/organization/certificates

Get certificate

admin.organization.certificates.retrieve(strcertificate_id, CertificateRetrieveParams**kwargs) -> Certificate

GET/organization/certificates/{certificate_id}

Modify certificate

admin.organization.certificates.update(strcertificate_id, CertificateUpdateParams**kwargs) -> Certificate

POST/organization/certificates/{certificate_id}

ModelsExpand Collapse

class Certificate: …

Represents an individual certificate uploaded to the organization.

class CertificateActivateResponse: …

Represents an individual certificate configured at the organization level.

class CertificateDeactivateResponse: …

Represents an individual certificate configured at the organization level.

class CertificateDeleteResponse: …

class CertificateListResponse: …

Represents an individual certificate configured at the organization level.

OrganizationData Retention

Retrieve organization data retention

admin.organization.data_retention.retrieve() -> OrganizationDataRetention

GET/organization/data_retention

Update organization data retention

admin.organization.data_retention.update(DataRetentionUpdateParams**kwargs) -> OrganizationDataRetention

POST/organization/data_retention

ModelsExpand Collapse

class OrganizationDataRetention: …

Represents the organization’s data retention control setting.

OrganizationGroups

Create group

admin.organization.groups.create(GroupCreateParams**kwargs) -> Group

POST/organization/groups

Delete group

admin.organization.groups.delete(strgroup_id) -> GroupDeleteResponse

DELETE/organization/groups/{group_id}

List groups

admin.organization.groups.list(GroupListParams**kwargs) -> SyncNextCursorPage[Group]

GET/organization/groups

Retrieve group

admin.organization.groups.retrieve(strgroup_id) -> Group

GET/organization/groups/{group_id}

Update group

admin.organization.groups.update(strgroup_id, GroupUpdateParams**kwargs) -> GroupUpdateResponse

POST/organization/groups/{group_id}

ModelsExpand Collapse

class Group: …

Details about an organization group.

class GroupDeleteResponse: …

Confirmation payload returned after deleting a group.

class GroupUpdateResponse: …

Response returned after updating a group.

OrganizationGroupsRoles

Assign organization role to group

admin.organization.groups.roles.create(strgroup_id, RoleCreateParams**kwargs) -> RoleCreateResponse

POST/organization/groups/{group_id}/roles

Unassign organization role from group

admin.organization.groups.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse

DELETE/organization/groups/{group_id}/roles/{role_id}

List group organization role assignments

admin.organization.groups.roles.list(strgroup_id, RoleListParams**kwargs) -> SyncNextCursorPage[RoleListResponse]

GET/organization/groups/{group_id}/roles

Retrieve group organization role

admin.organization.groups.roles.retrieve(strrole_id, RoleRetrieveParams**kwargs) -> RoleRetrieveResponse

GET/organization/groups/{group_id}/roles/{role_id}

ModelsExpand Collapse

class RoleCreateResponse: …

Role assignment linking a group to a role.

class RoleDeleteResponse: …

Confirmation payload returned after unassigning a role.

class RoleListResponse: …

Detailed information about a role assignment entry returned when listing assignments.

class RoleRetrieveResponse: …

Detailed information about a role assignment entry returned when listing assignments.

OrganizationGroupsUsers

Add group user

admin.organization.groups.users.create(strgroup_id, UserCreateParams**kwargs) -> UserCreateResponse

POST/organization/groups/{group_id}/users

Remove group user

admin.organization.groups.users.delete(struser_id, UserDeleteParams**kwargs) -> UserDeleteResponse

DELETE/organization/groups/{group_id}/users/{user_id}

List group users

admin.organization.groups.users.list(strgroup_id, UserListParams**kwargs) -> SyncNextCursorPage[OrganizationGroupUser]

GET/organization/groups/{group_id}/users

Retrieve group user

admin.organization.groups.users.retrieve(struser_id, UserRetrieveParams**kwargs) -> UserRetrieveResponse

GET/organization/groups/{group_id}/users/{user_id}

ModelsExpand Collapse

class OrganizationGroupUser: …

Represents an individual user returned when inspecting group membership.

class UserCreateResponse: …

Confirmation payload returned after adding a user to a group.

class UserDeleteResponse: …

Confirmation payload returned after removing a user from a group.

class UserRetrieveResponse: …

Details about a user returned from an organization group membership lookup.

OrganizationInvites

Create invite

admin.organization.invites.create(InviteCreateParams**kwargs) -> Invite

POST/organization/invites

Delete invite

admin.organization.invites.delete(strinvite_id) -> InviteDeleteResponse

DELETE/organization/invites/{invite_id}

List invites

admin.organization.invites.list(InviteListParams**kwargs) -> SyncConversationCursorPage[Invite]

GET/organization/invites

Retrieve invite

admin.organization.invites.retrieve(strinvite_id) -> Invite

GET/organization/invites/{invite_id}

ModelsExpand Collapse

class Invite: …

Represents an individual invite to the organization.

class InviteDeleteResponse: …

OrganizationProjects

Archive project

admin.organization.projects.archive(strproject_id) -> Project

POST/organization/projects/{project_id}/archive

Create project

admin.organization.projects.create(ProjectCreateParams**kwargs) -> Project

POST/organization/projects

List projects

admin.organization.projects.list(ProjectListParams**kwargs) -> SyncConversationCursorPage[Project]

GET/organization/projects

Retrieve project

admin.organization.projects.retrieve(strproject_id) -> Project

GET/organization/projects/{project_id}

Modify project

admin.organization.projects.update(strproject_id, ProjectUpdateParams**kwargs) -> Project

POST/organization/projects/{project_id}

ModelsExpand Collapse

class Project: …

Represents an individual project.

OrganizationProjectsAPI Keys

Delete project API key

admin.organization.projects.api_keys.delete(strapi_key_id, APIKeyDeleteParams**kwargs) -> APIKeyDeleteResponse

DELETE/organization/projects/{project_id}/api_keys/{api_key_id}

List project API keys

admin.organization.projects.api_keys.list(strproject_id, APIKeyListParams**kwargs) -> SyncConversationCursorPage[ProjectAPIKey]

GET/organization/projects/{project_id}/api_keys

Retrieve project API key

admin.organization.projects.api_keys.retrieve(strapi_key_id, APIKeyRetrieveParams**kwargs) -> ProjectAPIKey

GET/organization/projects/{project_id}/api_keys/{api_key_id}

ModelsExpand Collapse

class APIKeyDeleteResponse: …

class ProjectAPIKey: …

Represents an individual API key in a project.

OrganizationProjectsCertificates

Activate certificates for project

admin.organization.projects.certificates.activate(strproject_id, CertificateActivateParams**kwargs) -> SyncPage[CertificateActivateResponse]

POST/organization/projects/{project_id}/certificates/activate

Deactivate certificates for project

admin.organization.projects.certificates.deactivate(strproject_id, CertificateDeactivateParams**kwargs) -> SyncPage[CertificateDeactivateResponse]

POST/organization/projects/{project_id}/certificates/deactivate

List project certificates

admin.organization.projects.certificates.list(strproject_id, CertificateListParams**kwargs) -> SyncConversationCursorPage[CertificateListResponse]

GET/organization/projects/{project_id}/certificates

ModelsExpand Collapse

class CertificateActivateResponse: …

Represents an individual certificate configured at the project level.

class CertificateDeactivateResponse: …

Represents an individual certificate configured at the project level.

class CertificateListResponse: …

Represents an individual certificate configured at the project level.

OrganizationProjectsData Retention

Retrieve project data retention

admin.organization.projects.data_retention.retrieve(strproject_id) -> ProjectDataRetention

GET/organization/projects/{project_id}/data_retention

Update project data retention

admin.organization.projects.data_retention.update(strproject_id, DataRetentionUpdateParams**kwargs) -> ProjectDataRetention

POST/organization/projects/{project_id}/data_retention

ModelsExpand Collapse

class ProjectDataRetention: …

Represents a project’s data retention control setting.

OrganizationProjectsGroups

Add project group

admin.organization.projects.groups.create(strproject_id, GroupCreateParams**kwargs) -> ProjectGroup

POST/organization/projects/{project_id}/groups

Remove project group

admin.organization.projects.groups.delete(strgroup_id, GroupDeleteParams**kwargs) -> GroupDeleteResponse

DELETE/organization/projects/{project_id}/groups/{group_id}

List project groups

admin.organization.projects.groups.list(strproject_id, GroupListParams**kwargs) -> SyncNextCursorPage[ProjectGroup]

GET/organization/projects/{project_id}/groups

Retrieve project group

admin.organization.projects.groups.retrieve(strgroup_id, GroupRetrieveParams**kwargs) -> ProjectGroup

GET/organization/projects/{project_id}/groups/{group_id}

ModelsExpand Collapse

class GroupDeleteResponse: …

Confirmation payload returned after removing a group from a project.

class ProjectGroup: …

Details about a group’s membership in a project.

OrganizationProjectsGroupsRoles

Assign project role to group

admin.organization.projects.groups.roles.create(strgroup_id, RoleCreateParams**kwargs) -> RoleCreateResponse

POST/projects/{project_id}/groups/{group_id}/roles

Unassign project role from group

admin.organization.projects.groups.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse

DELETE/projects/{project_id}/groups/{group_id}/roles/{role_id}

List project group role assignments

admin.organization.projects.groups.roles.list(strgroup_id, RoleListParams**kwargs) -> SyncNextCursorPage[RoleListResponse]

GET/projects/{project_id}/groups/{group_id}/roles

Retrieve project group role

admin.organization.projects.groups.roles.retrieve(strrole_id, RoleRetrieveParams**kwargs) -> RoleRetrieveResponse

GET/projects/{project_id}/groups/{group_id}/roles/{role_id}

ModelsExpand Collapse

class RoleCreateResponse: …

Role assignment linking a group to a role.

class RoleDeleteResponse: …

Confirmation payload returned after unassigning a role.

class RoleListResponse: …

Detailed information about a role assignment entry returned when listing assignments.

class RoleRetrieveResponse: …

Detailed information about a role assignment entry returned when listing assignments.

OrganizationProjectsHosted Tool Permissions

Retrieve project hosted tool permissions

admin.organization.projects.hosted_tool_permissions.retrieve(strproject_id) -> ProjectHostedToolPermissions

GET/organization/projects/{project_id}/hosted_tool_permissions

Modify project hosted tool permissions

admin.organization.projects.hosted_tool_permissions.update(strproject_id, HostedToolPermissionUpdateParams**kwargs) -> ProjectHostedToolPermissions

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

admin.organization.projects.model_permissions.delete(strproject_id) -> ProjectModelPermissionsDeleted

DELETE/organization/projects/{project_id}/model_permissions

Retrieve project model permissions

admin.organization.projects.model_permissions.retrieve(strproject_id) -> ProjectModelPermissions

GET/organization/projects/{project_id}/model_permissions

Modify project model permissions

admin.organization.projects.model_permissions.update(strproject_id, ModelPermissionUpdateParams**kwargs) -> ProjectModelPermissions

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

admin.organization.projects.rate_limits.list_rate_limits(strproject_id, RateLimitListRateLimitsParams**kwargs) -> SyncConversationCursorPage[ProjectRateLimit]

GET/organization/projects/{project_id}/rate_limits

Modify project rate limit

admin.organization.projects.rate_limits.update_rate_limit(strrate_limit_id, RateLimitUpdateRateLimitParams**kwargs) -> ProjectRateLimit

POST/organization/projects/{project_id}/rate_limits/{rate_limit_id}

ModelsExpand Collapse

class ProjectRateLimit: …

Represents a project rate limit config.

OrganizationProjectsRoles

Create project role

admin.organization.projects.roles.create(strproject_id, RoleCreateParams**kwargs) -> Role

POST/projects/{project_id}/roles

Delete project role

admin.organization.projects.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse

DELETE/projects/{project_id}/roles/{role_id}

List project roles

admin.organization.projects.roles.list(strproject_id, RoleListParams**kwargs) -> SyncNextCursorPage[Role]

GET/projects/{project_id}/roles

Retrieve project role

admin.organization.projects.roles.retrieve(strrole_id, RoleRetrieveParams**kwargs) -> Role

GET/projects/{project_id}/roles/{role_id}

Update project role

admin.organization.projects.roles.update(strrole_id, RoleUpdateParams**kwargs) -> Role

POST/projects/{project_id}/roles/{role_id}

ModelsExpand Collapse

class RoleDeleteResponse: …

Confirmation payload returned after deleting a role.

OrganizationProjectsService Accounts

Create project service account

admin.organization.projects.service_accounts.create(strproject_id, ServiceAccountCreateParams**kwargs) -> ServiceAccountCreateResponse

POST/organization/projects/{project_id}/service_accounts

Delete project service account

admin.organization.projects.service_accounts.delete(strservice_account_id, ServiceAccountDeleteParams**kwargs) -> ServiceAccountDeleteResponse

DELETE/organization/projects/{project_id}/service_accounts/{service_account_id}

List project service accounts

admin.organization.projects.service_accounts.list(strproject_id, ServiceAccountListParams**kwargs) -> SyncConversationCursorPage[ProjectServiceAccount]

GET/organization/projects/{project_id}/service_accounts

Retrieve project service account

admin.organization.projects.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> ProjectServiceAccount

GET/organization/projects/{project_id}/service_accounts/{service_account_id}

Update project service account

admin.organization.projects.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> ProjectServiceAccount

POST/organization/projects/{project_id}/service_accounts/{service_account_id}

ModelsExpand Collapse

class ProjectServiceAccount: …

Represents an individual service account in a project.

class ServiceAccountCreateResponse: …

class ServiceAccountDeleteResponse: …

OrganizationProjectsService AccountsAPI Keys

Create project service account API key

admin.organization.projects.service_accounts.api_keys.create(strservice_account_id, APIKeyCreateParams**kwargs) -> APIKeyCreateResponse

POST/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys

ModelsExpand Collapse

class APIKeyCreateResponse: …

OrganizationProjectsSpend Alerts

Create project spend alert

admin.organization.projects.spend_alerts.create(strproject_id, SpendAlertCreateParams**kwargs) -> ProjectSpendAlert

POST/organization/projects/{project_id}/spend_alerts

Delete project spend alert

admin.organization.projects.spend_alerts.delete(stralert_id, SpendAlertDeleteParams**kwargs) -> ProjectSpendAlertDeleted

DELETE/organization/projects/{project_id}/spend_alerts/{alert_id}

List project spend alerts

admin.organization.projects.spend_alerts.list(strproject_id, SpendAlertListParams**kwargs) -> SyncConversationCursorPage[ProjectSpendAlert]

GET/organization/projects/{project_id}/spend_alerts

Retrieve project spend alert

admin.organization.projects.spend_alerts.retrieve(stralert_id, SpendAlertRetrieveParams**kwargs) -> ProjectSpendAlert

GET/organization/projects/{project_id}/spend_alerts/{alert_id}

Update project spend alert

admin.organization.projects.spend_alerts.update(stralert_id, SpendAlertUpdateParams**kwargs) -> ProjectSpendAlert

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

admin.organization.projects.spend_limit.delete(strproject_id) -> ProjectSpendLimitDeleted

DELETE/organization/projects/{project_id}/spend_limit

Retrieve project spend limit

admin.organization.projects.spend_limit.retrieve(strproject_id) -> ProjectSpendLimit

GET/organization/projects/{project_id}/spend_limit

Update project spend limit

admin.organization.projects.spend_limit.update(strproject_id, SpendLimitUpdateParams**kwargs) -> ProjectSpendLimit

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

admin.organization.projects.users.create(strproject_id, UserCreateParams**kwargs) -> ProjectUser

POST/organization/projects/{project_id}/users

Delete project user

admin.organization.projects.users.delete(struser_id, UserDeleteParams**kwargs) -> UserDeleteResponse

DELETE/organization/projects/{project_id}/users/{user_id}

List project users

admin.organization.projects.users.list(strproject_id, UserListParams**kwargs) -> SyncConversationCursorPage[ProjectUser]

GET/organization/projects/{project_id}/users

Retrieve project user

admin.organization.projects.users.retrieve(struser_id, UserRetrieveParams**kwargs) -> ProjectUser

GET/organization/projects/{project_id}/users/{user_id}

Modify project user

admin.organization.projects.users.update(struser_id, UserUpdateParams**kwargs) -> ProjectUser

POST/organization/projects/{project_id}/users/{user_id}

ModelsExpand Collapse

class ProjectUser: …

Represents an individual user in a project.

class UserDeleteResponse: …

OrganizationProjectsUsersRoles

Assign project role to user

admin.organization.projects.users.roles.create(struser_id, RoleCreateParams**kwargs) -> RoleCreateResponse

POST/projects/{project_id}/users/{user_id}/roles

Unassign project role from user

admin.organization.projects.users.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse

DELETE/projects/{project_id}/users/{user_id}/roles/{role_id}

List project user role assignments

admin.organization.projects.users.roles.list(struser_id, RoleListParams**kwargs) -> SyncNextCursorPage[RoleListResponse]

GET/projects/{project_id}/users/{user_id}/roles

Retrieve project user role

admin.organization.projects.users.roles.retrieve(strrole_id, RoleRetrieveParams**kwargs) -> RoleRetrieveResponse

GET/projects/{project_id}/users/{user_id}/roles/{role_id}

ModelsExpand Collapse

class RoleCreateResponse: …

Role assignment linking a user to a role.

class RoleDeleteResponse: …

Confirmation payload returned after unassigning a role.

class RoleListResponse: …

Detailed information about a role assignment entry returned when listing assignments.

class RoleRetrieveResponse: …

Detailed information about a role assignment entry returned when listing assignments.

OrganizationRoles

Create organization role

admin.organization.roles.create(RoleCreateParams**kwargs) -> Role

POST/organization/roles

Delete organization role

admin.organization.roles.delete(strrole_id) -> RoleDeleteResponse

DELETE/organization/roles/{role_id}

List organization roles

admin.organization.roles.list(RoleListParams**kwargs) -> SyncNextCursorPage[Role]

GET/organization/roles

Retrieve organization role

admin.organization.roles.retrieve(strrole_id) -> Role

GET/organization/roles/{role_id}

Update organization role

admin.organization.roles.update(strrole_id, RoleUpdateParams**kwargs) -> Role

POST/organization/roles/{role_id}

ModelsExpand Collapse

class Role: …

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

class RoleDeleteResponse: …

Confirmation payload returned after deleting a role.

OrganizationSpend Alerts

Create organization spend alert

admin.organization.spend_alerts.create(SpendAlertCreateParams**kwargs) -> OrganizationSpendAlert

POST/organization/spend_alerts

Delete organization spend alert

admin.organization.spend_alerts.delete(stralert_id) -> OrganizationSpendAlertDeleted

DELETE/organization/spend_alerts/{alert_id}

List organization spend alerts

admin.organization.spend_alerts.list(SpendAlertListParams**kwargs) -> SyncConversationCursorPage[OrganizationSpendAlert]

GET/organization/spend_alerts

Retrieve organization spend alert

admin.organization.spend_alerts.retrieve(stralert_id) -> OrganizationSpendAlert

GET/organization/spend_alerts/{alert_id}

Update organization spend alert

admin.organization.spend_alerts.update(stralert_id, SpendAlertUpdateParams**kwargs) -> OrganizationSpendAlert

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

admin.organization.spend_limit.delete() -> OrganizationSpendLimitDeleted

DELETE/organization/spend_limit

Retrieve organization spend limit

admin.organization.spend_limit.retrieve() -> OrganizationSpendLimit

GET/organization/spend_limit

Update organization spend limit

admin.organization.spend_limit.update(SpendLimitUpdateParams**kwargs) -> OrganizationSpendLimit

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

admin.organization.usage.audio_speeches(UsageAudioSpeechesParams**kwargs) -> UsageAudioSpeechesResponse

GET/organization/usage/audio_speeches

Audio transcriptions

admin.organization.usage.audio_transcriptions(UsageAudioTranscriptionsParams**kwargs) -> UsageAudioTranscriptionsResponse

GET/organization/usage/audio_transcriptions

Code interpreter sessions

admin.organization.usage.code_interpreter_sessions(UsageCodeInterpreterSessionsParams**kwargs) -> UsageCodeInterpreterSessionsResponse

GET/organization/usage/code_interpreter_sessions

Completions

admin.organization.usage.completions(UsageCompletionsParams**kwargs) -> UsageCompletionsResponse

GET/organization/usage/completions

Costs

admin.organization.usage.costs(UsageCostsParams**kwargs) -> UsageCostsResponse

GET/organization/costs

Embeddings

admin.organization.usage.embeddings(UsageEmbeddingsParams**kwargs) -> UsageEmbeddingsResponse

GET/organization/usage/embeddings

File search calls

admin.organization.usage.file_search_calls(UsageFileSearchCallsParams**kwargs) -> UsageFileSearchCallsResponse

GET/organization/usage/file_search_calls

Images

admin.organization.usage.images(UsageImagesParams**kwargs) -> UsageImagesResponse

GET/organization/usage/images

Moderations

admin.organization.usage.moderations(UsageModerationsParams**kwargs) -> UsageModerationsResponse

GET/organization/usage/moderations

Vector stores

admin.organization.usage.vector_stores(UsageVectorStoresParams**kwargs) -> UsageVectorStoresResponse

GET/organization/usage/vector_stores

Web search calls

admin.organization.usage.web_search_calls(UsageWebSearchCallsParams**kwargs) -> UsageWebSearchCallsResponse

GET/organization/usage/web_search_calls

ModelsExpand Collapse

class UsageAudioSpeechesResponse: …

class UsageAudioTranscriptionsResponse: …

class UsageCodeInterpreterSessionsResponse: …

class UsageCompletionsResponse: …

class UsageCostsResponse: …

class UsageEmbeddingsResponse: …

class UsageFileSearchCallsResponse: …

class UsageImagesResponse: …

class UsageModerationsResponse: …

class UsageVectorStoresResponse: …

class UsageWebSearchCallsResponse: …

OrganizationUsers

Delete user

admin.organization.users.delete(struser_id) -> UserDeleteResponse

DELETE/organization/users/{user_id}

List users

admin.organization.users.list(UserListParams**kwargs) -> SyncConversationCursorPage[OrganizationUser]

GET/organization/users

Retrieve user

admin.organization.users.retrieve(struser_id) -> OrganizationUser

GET/organization/users/{user_id}

Modify user

admin.organization.users.update(struser_id, UserUpdateParams**kwargs) -> OrganizationUser

POST/organization/users/{user_id}

ModelsExpand Collapse

class OrganizationUser: …

Represents an individual user within an organization.

class UserDeleteResponse: …

OrganizationUsersRoles

Assign organization role to user

admin.organization.users.roles.create(struser_id, RoleCreateParams**kwargs) -> RoleCreateResponse

POST/organization/users/{user_id}/roles

Unassign organization role from user

admin.organization.users.roles.delete(strrole_id, RoleDeleteParams**kwargs) -> RoleDeleteResponse

DELETE/organization/users/{user_id}/roles/{role_id}

List user organization role assignments

admin.organization.users.roles.list(struser_id, RoleListParams**kwargs) -> SyncNextCursorPage[RoleListResponse]

GET/organization/users/{user_id}/roles

Retrieve user organization role

admin.organization.users.roles.retrieve(strrole_id, RoleRetrieveParams**kwargs) -> RoleRetrieveResponse

GET/organization/users/{user_id}/roles/{role_id}

ModelsExpand Collapse

class RoleCreateResponse: …

Role assignment linking a user to a role.

class RoleDeleteResponse: …

Confirmation payload returned after unassigning a role.

class RoleListResponse: …

Detailed information about a role assignment entry returned when listing assignments.

class RoleRetrieveResponse: …

Detailed information about a role assignment entry returned when listing assignments.