API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Admin

AdminOrganization

AdminOrganizationAudit Logs

List user actions and configuration changes within this organization.

List audit logs

client.Admin.Organization.AuditLogs.List(ctx, query) (*ConversationCursorPage[AdminOrganizationAuditLogListResponse], error)

GET/organization/audit_logs

AdminOrganizationAdmin API Keys

List all organization and project API keys.

client.Admin.Organization.AdminAPIKeys.List(ctx, query) (*CursorPage[AdminAPIKey], error)

GET/organization/admin_api_keys

Create admin API key

client.Admin.Organization.AdminAPIKeys.New(ctx, body) (*AdminOrganizationAdminAPIKeyNewResponse, error)

POST/organization/admin_api_keys

Retrieve admin API key

client.Admin.Organization.AdminAPIKeys.Get(ctx, keyID) (*AdminAPIKey, error)

GET/organization/admin_api_keys/{key_id}

Delete admin API key

client.Admin.Organization.AdminAPIKeys.Delete(ctx, keyID) (*AdminOrganizationAdminAPIKeyDeleteResponse, error)

DELETE/organization/admin_api_keys/{key_id}

ModelsExpand Collapse

type AdminAPIKey struct{…}

Represents an individual Admin API key in an org.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the API key was created

formatunixtime

Object OrganizationAdminAPIKey

The object type, which is always organization.admin_api_key

Owner AdminAPIKeyOwner

ID stringOptional

The identifier, which can be referenced in API endpoints

CreatedAt int64Optional

The Unix timestamp (in seconds) of when the user was created

formatunixtime

Name stringOptional

The name of the user

Object stringOptional

The object type, which is always organization.user

Role stringOptional

Always owner

Type stringOptional

Always user

RedactedValue string

The redacted value of the API key

LastUsedAt int64Optional

The Unix timestamp (in seconds) of when the API key was last used

formatunixtime

Name stringOptional

The name of the API key

AdminOrganizationUsage

Audio speeches

client.Admin.Organization.Usage.AudioSpeeches(ctx, query) (*AdminOrganizationUsageAudioSpeechesResponse, error)

GET/organization/usage/audio_speeches

Audio transcriptions

client.Admin.Organization.Usage.AudioTranscriptions(ctx, query) (*AdminOrganizationUsageAudioTranscriptionsResponse, error)

GET/organization/usage/audio_transcriptions

Code interpreter sessions

client.Admin.Organization.Usage.CodeInterpreterSessions(ctx, query) (*AdminOrganizationUsageCodeInterpreterSessionsResponse, error)

GET/organization/usage/code_interpreter_sessions

Completions

client.Admin.Organization.Usage.Completions(ctx, query) (*AdminOrganizationUsageCompletionsResponse, error)

GET/organization/usage/completions

Embeddings

client.Admin.Organization.Usage.Embeddings(ctx, query) (*AdminOrganizationUsageEmbeddingsResponse, error)

GET/organization/usage/embeddings

Images

client.Admin.Organization.Usage.Images(ctx, query) (*AdminOrganizationUsageImagesResponse, error)

GET/organization/usage/images

Moderations

client.Admin.Organization.Usage.Moderations(ctx, query) (*AdminOrganizationUsageModerationsResponse, error)

GET/organization/usage/moderations

Vector stores

client.Admin.Organization.Usage.VectorStores(ctx, query) (*AdminOrganizationUsageVectorStoresResponse, error)

GET/organization/usage/vector_stores

File search calls

client.Admin.Organization.Usage.FileSearchCalls(ctx, query) (*AdminOrganizationUsageFileSearchCallsResponse, error)

GET/organization/usage/file_search_calls

Web search calls

client.Admin.Organization.Usage.WebSearchCalls(ctx, query) (*AdminOrganizationUsageWebSearchCallsResponse, error)

GET/organization/usage/web_search_calls

Costs

client.Admin.Organization.Usage.Costs(ctx, query) (*AdminOrganizationUsageCostsResponse, error)

GET/organization/costs

AdminOrganizationInvites

List invites

client.Admin.Organization.Invites.List(ctx, query) (*ConversationCursorPage[Invite], error)

GET/organization/invites

Create invite

client.Admin.Organization.Invites.New(ctx, body) (*Invite, error)

POST/organization/invites

Retrieve invite

client.Admin.Organization.Invites.Get(ctx, inviteID) (*Invite, error)

GET/organization/invites/{invite_id}

Delete invite

client.Admin.Organization.Invites.Delete(ctx, inviteID) (*AdminOrganizationInviteDeleteResponse, error)

DELETE/organization/invites/{invite_id}

ModelsExpand Collapse

type Invite struct{…}

Represents an individual invite to the organization.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the invite was sent.

formatunixtime

Email string

The email address of the individual to whom the invite was sent

Object OrganizationInvite

The object type, which is always organization.invite

Projects []InviteProject

The projects that were granted membership upon acceptance of the invite.

ID string

Project’s public ID

Role string

Project membership role

One of the following:

const InviteProjectRoleMember InviteProjectRole = "member"

const InviteProjectRoleOwner InviteProjectRole = "owner"

Role InviteRole

owner or reader

One of the following:

const InviteRoleOwner InviteRole = "owner"

const InviteRoleReader InviteRole = "reader"

Status InviteStatus

accepted,expired, or pending

One of the following:

const InviteStatusAccepted InviteStatus = "accepted"

const InviteStatusExpired InviteStatus = "expired"

const InviteStatusPending InviteStatus = "pending"

AcceptedAt int64Optional

The Unix timestamp (in seconds) of when the invite was accepted.

formatunixtime

ExpiresAt int64Optional

The Unix timestamp (in seconds) of when the invite expires.

formatunixtime

AdminOrganizationUsers

List users

client.Admin.Organization.Users.List(ctx, query) (*ConversationCursorPage[OrganizationUser], error)

GET/organization/users

Retrieve user

client.Admin.Organization.Users.Get(ctx, userID) (*OrganizationUser, error)

GET/organization/users/{user_id}

Modify user

client.Admin.Organization.Users.Update(ctx, userID, body) (*OrganizationUser, error)

POST/organization/users/{user_id}

Delete user

client.Admin.Organization.Users.Delete(ctx, userID) (*AdminOrganizationUserDeleteResponse, error)

DELETE/organization/users/{user_id}

ModelsExpand Collapse

type OrganizationUser struct{…}

Represents an individual user within an organization.

ID string

The identifier, which can be referenced in API endpoints

AddedAt int64

The Unix timestamp (in seconds) of when the user was added.

formatunixtime

Object OrganizationUser

The object type, which is always organization.user

APIKeyLastUsedAt int64Optional

The Unix timestamp (in seconds) of the user’s last API key usage.

formatunixtime

Created int64Optional

The Unix timestamp (in seconds) of when the user was created.

formatunixtime

DeveloperPersona stringOptional

The developer persona metadata for the user.

Email stringOptional

The email address of the user

IsDefault boolOptional

Whether this is the organization’s default user.

IsScaleTierAuthorizedPurchaser boolOptional

Whether the user is an authorized purchaser for Scale Tier.

IsScimManaged boolOptional

Whether the user is managed through SCIM.

IsServiceAccount boolOptional

Whether the user is a service account.

Name stringOptional

The name of the user

Projects OrganizationUserProjectsOptional

Projects associated with the user, if included.

Data []OrganizationUserProjectsData

ID stringOptional

Name stringOptional

Role stringOptional

Object List

Role stringOptional

owner or reader

TechnicalLevel stringOptional

The technical level metadata for the user.

User OrganizationUserUserOptional

Nested user details.

ID string

Object User

Banned boolOptional

BannedAt int64Optional

formatunixtime

Email stringOptional

Enabled boolOptional

Name stringOptional

Picture stringOptional

AdminOrganizationUsersRoles

List user organization role assignments

client.Admin.Organization.Users.Roles.List(ctx, userID, query) (*NextCursorPage[AdminOrganizationUserRoleListResponse], error)

GET/organization/users/{user_id}/roles

Assign organization role to user

client.Admin.Organization.Users.Roles.New(ctx, userID, body) (*AdminOrganizationUserRoleNewResponse, error)

POST/organization/users/{user_id}/roles

Retrieve user organization role

client.Admin.Organization.Users.Roles.Get(ctx, userID, roleID) (*AdminOrganizationUserRoleGetResponse, error)

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

Unassign organization role from user

client.Admin.Organization.Users.Roles.Delete(ctx, userID, roleID) (*AdminOrganizationUserRoleDeleteResponse, error)

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

AdminOrganizationGroups

List groups

client.Admin.Organization.Groups.List(ctx, query) (*NextCursorPage[Group], error)

GET/organization/groups

Create group

client.Admin.Organization.Groups.New(ctx, body) (*Group, error)

POST/organization/groups

Retrieve group

client.Admin.Organization.Groups.Get(ctx, groupID) (*Group, error)

GET/organization/groups/{group_id}

Update group

client.Admin.Organization.Groups.Update(ctx, groupID, body) (*AdminOrganizationGroupUpdateResponse, error)

POST/organization/groups/{group_id}

Delete group

client.Admin.Organization.Groups.Delete(ctx, groupID) (*AdminOrganizationGroupDeleteResponse, error)

DELETE/organization/groups/{group_id}

ModelsExpand Collapse

type Group struct{…}

Details about an organization group.

ID string

Identifier for the group.

CreatedAt int64

Unix timestamp (in seconds) when the group was created.

formatunixtime

GroupType GroupGroupType

The type of the group.

One of the following:

const GroupGroupTypeGroup GroupGroupType = "group"

const GroupGroupTypeTenantGroup GroupGroupType = "tenant_group"

IsScimManaged bool

Whether the group is managed through SCIM and controlled by your identity provider.

Name string

Display name of the group.

AdminOrganizationGroupsUsers

List group users

client.Admin.Organization.Groups.Users.List(ctx, groupID, query) (*NextCursorPage[OrganizationGroupUser], error)

GET/organization/groups/{group_id}/users

Add group user

client.Admin.Organization.Groups.Users.New(ctx, groupID, body) (*AdminOrganizationGroupUserNewResponse, error)

POST/organization/groups/{group_id}/users

Retrieve group user

client.Admin.Organization.Groups.Users.Get(ctx, groupID, userID) (*AdminOrganizationGroupUserGetResponse, error)

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

Remove group user

client.Admin.Organization.Groups.Users.Delete(ctx, groupID, userID) (*AdminOrganizationGroupUserDeleteResponse, error)

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

ModelsExpand Collapse

type OrganizationGroupUser struct{…}

Represents an individual user returned when inspecting group membership.

ID string

The identifier, which can be referenced in API endpoints

Email string

The email address of the user.

Name string

The name of the user.

AdminOrganizationGroupsRoles

List group organization role assignments

client.Admin.Organization.Groups.Roles.List(ctx, groupID, query) (*NextCursorPage[AdminOrganizationGroupRoleListResponse], error)

GET/organization/groups/{group_id}/roles

Assign organization role to group

client.Admin.Organization.Groups.Roles.New(ctx, groupID, body) (*AdminOrganizationGroupRoleNewResponse, error)

POST/organization/groups/{group_id}/roles

Retrieve group organization role

client.Admin.Organization.Groups.Roles.Get(ctx, groupID, roleID) (*AdminOrganizationGroupRoleGetResponse, error)

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

Unassign organization role from group

client.Admin.Organization.Groups.Roles.Delete(ctx, groupID, roleID) (*AdminOrganizationGroupRoleDeleteResponse, error)

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

AdminOrganizationRoles

List organization roles

client.Admin.Organization.Roles.List(ctx, query) (*NextCursorPage[Role], error)

GET/organization/roles

Create organization role

client.Admin.Organization.Roles.New(ctx, body) (*Role, error)

POST/organization/roles

Retrieve organization role

client.Admin.Organization.Roles.Get(ctx, roleID) (*Role, error)

GET/organization/roles/{role_id}

Update organization role

client.Admin.Organization.Roles.Update(ctx, roleID, body) (*Role, error)

POST/organization/roles/{role_id}

Delete organization role

client.Admin.Organization.Roles.Delete(ctx, roleID) (*AdminOrganizationRoleDeleteResponse, error)

DELETE/organization/roles/{role_id}

ModelsExpand Collapse

type Role struct{…}

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

ID string

Identifier for the role.

Description string

Optional description of the role.

Name string

Unique name for the role.

Object Role

Always role.

Permissions []string

Permissions granted by the role.

PredefinedRole bool

Whether the role is predefined and managed by OpenAI.

ResourceType string

Resource type the role is bound to (for example api.organization or api.project).

AdminOrganizationData Retention

Retrieve organization data retention

client.Admin.Organization.DataRetention.Get(ctx) (*OrganizationDataRetention, error)

GET/organization/data_retention

Update organization data retention

client.Admin.Organization.DataRetention.Update(ctx, body) (*OrganizationDataRetention, error)

POST/organization/data_retention

ModelsExpand Collapse

type OrganizationDataRetention struct{…}

Represents the organization’s data retention control setting.

Object OrganizationDataRetention

The object type, which is always organization.data_retention.

Type OrganizationDataRetentionType

The configured organization data retention type.

One of the following:

const OrganizationDataRetentionTypeZeroDataRetention OrganizationDataRetentionType = "zero_data_retention"

const OrganizationDataRetentionTypeModifiedAbuseMonitoring OrganizationDataRetentionType = "modified_abuse_monitoring"

const OrganizationDataRetentionTypeEnhancedZeroDataRetention OrganizationDataRetentionType = "enhanced_zero_data_retention"

const OrganizationDataRetentionTypeEnhancedModifiedAbuseMonitoring OrganizationDataRetentionType = "enhanced_modified_abuse_monitoring"

AdminOrganizationSpend Alerts

List organization spend alerts

client.Admin.Organization.SpendAlerts.List(ctx, query) (*ConversationCursorPage[OrganizationSpendAlert], error)

GET/organization/spend_alerts

Create organization spend alert

client.Admin.Organization.SpendAlerts.New(ctx, body) (*OrganizationSpendAlert, error)

POST/organization/spend_alerts

Update organization spend alert

client.Admin.Organization.SpendAlerts.Update(ctx, alertID, body) (*OrganizationSpendAlert, error)

POST/organization/spend_alerts/{alert_id}

Delete organization spend alert

client.Admin.Organization.SpendAlerts.Delete(ctx, alertID) (*OrganizationSpendAlertDeleted, error)

DELETE/organization/spend_alerts/{alert_id}

ModelsExpand Collapse

type OrganizationSpendAlert struct{…}

Represents a spend alert configured at the organization level.

ID string

The identifier, which can be referenced in API endpoints.

Currency OrganizationSpendAlertCurrency

The currency for the threshold amount.

Interval OrganizationSpendAlertInterval

The time interval for evaluating spend against the threshold.

NotificationChannel OrganizationSpendAlertNotificationChannel

Email notification settings for a spend alert.

Recipients []string

Email addresses that receive the spend alert notification.

Type Email

The notification channel type. Currently only email is supported.

SubjectPrefix stringOptional

Optional subject prefix for alert emails.

Object OrganizationSpendAlert

The object type, which is always organization.spend_alert.

ThresholdAmount int64

The alert threshold amount, in cents.

type OrganizationSpendAlertDeleted struct{…}

Confirmation payload returned after deleting an organization spend alert.

ID string

The deleted spend alert ID.

Deleted bool

Whether the spend alert was deleted.

Object OrganizationSpendAlertDeleted

Always organization.spend_alert.deleted.

AdminOrganizationCertificates

List organization certificates

client.Admin.Organization.Certificates.List(ctx, query) (*ConversationCursorPage[AdminOrganizationCertificateListResponse], error)

GET/organization/certificates

Upload certificate

client.Admin.Organization.Certificates.New(ctx, body) (*Certificate, error)

POST/organization/certificates

Get certificate

client.Admin.Organization.Certificates.Get(ctx, certificateID, query) (*Certificate, error)

GET/organization/certificates/{certificate_id}

Modify certificate

client.Admin.Organization.Certificates.Update(ctx, certificateID, body) (*Certificate, error)

POST/organization/certificates/{certificate_id}

Delete certificate

client.Admin.Organization.Certificates.Delete(ctx, certificateID) (*AdminOrganizationCertificateDeleteResponse, error)

DELETE/organization/certificates/{certificate_id}

Activate certificates for organization

client.Admin.Organization.Certificates.Activate(ctx, body) (*Page[AdminOrganizationCertificateActivateResponse], error)

POST/organization/certificates/activate

Deactivate certificates for organization

client.Admin.Organization.Certificates.Deactivate(ctx, body) (*Page[AdminOrganizationCertificateDeactivateResponse], error)

POST/organization/certificates/deactivate

ModelsExpand Collapse

type Certificate struct{…}

Represents an individual certificate uploaded to the organization.

ID string

The identifier, which can be referenced in API endpoints

CertificateDetails CertificateCertificateDetails

Content stringOptional

The content of the certificate in PEM format.

ExpiresAt int64Optional

The Unix timestamp (in seconds) of when the certificate expires.

formatunixtime

ValidAt int64Optional

The Unix timestamp (in seconds) of when the certificate becomes valid.

formatunixtime

CreatedAt int64

The Unix timestamp (in seconds) of when the certificate was uploaded.

formatunixtime

Name string

The name of the certificate.

Object CertificateObject

The object type.

• If creating, updating, or getting a specific certificate, the object type is certificate.
• If listing, activating, or deactivating certificates for the organization, the object type is organization.certificate.
• If listing, activating, or deactivating certificates for a project, the object type is organization.project.certificate.

One of the following:

const CertificateObjectCertificate CertificateObject = "certificate"

const CertificateObjectOrganizationCertificate CertificateObject = "organization.certificate"

const CertificateObjectOrganizationProjectCertificate CertificateObject = "organization.project.certificate"

Active boolOptional

Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.

AdminOrganizationProjects

List projects

client.Admin.Organization.Projects.List(ctx, query) (*ConversationCursorPage[Project], error)

GET/organization/projects

Create project

client.Admin.Organization.Projects.New(ctx, body) (*Project, error)

POST/organization/projects

Retrieve project

client.Admin.Organization.Projects.Get(ctx, projectID) (*Project, error)

GET/organization/projects/{project_id}

Modify project

client.Admin.Organization.Projects.Update(ctx, projectID, body) (*Project, error)

POST/organization/projects/{project_id}

Archive project

client.Admin.Organization.Projects.Archive(ctx, projectID) (*Project, error)

POST/organization/projects/{project_id}/archive

ModelsExpand Collapse

type Project struct{…}

Represents an individual project.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the project was created.

formatunixtime

Object OrganizationProject

The object type, which is always organization.project

ArchivedAt int64Optional

The Unix timestamp (in seconds) of when the project was archived or null.

formatunixtime

ExternalKeyID stringOptional

The external key associated with the project.

Name stringOptional

The name of the project. This appears in reporting.

Status stringOptional

active or archived

AdminOrganizationProjectsUsers

List project users

client.Admin.Organization.Projects.Users.List(ctx, projectID, query) (*ConversationCursorPage[ProjectUser], error)

GET/organization/projects/{project_id}/users

Create project user

client.Admin.Organization.Projects.Users.New(ctx, projectID, body) (*ProjectUser, error)

POST/organization/projects/{project_id}/users

Retrieve project user

client.Admin.Organization.Projects.Users.Get(ctx, projectID, userID) (*ProjectUser, error)

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

Modify project user

client.Admin.Organization.Projects.Users.Update(ctx, projectID, userID, body) (*ProjectUser, error)

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

Delete project user

client.Admin.Organization.Projects.Users.Delete(ctx, projectID, userID) (*AdminOrganizationProjectUserDeleteResponse, error)

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

ModelsExpand Collapse

type ProjectUser struct{…}

Represents an individual user in a project.

ID string

The identifier, which can be referenced in API endpoints

AddedAt int64

The Unix timestamp (in seconds) of when the project was added.

formatunixtime

Object OrganizationProjectUser

The object type, which is always organization.project.user

Role string

owner or member

Email stringOptional

The email address of the user

Name stringOptional

The name of the user

AdminOrganizationProjectsUsersRoles

List project user role assignments

client.Admin.Organization.Projects.Users.Roles.List(ctx, projectID, userID, query) (*NextCursorPage[AdminOrganizationProjectUserRoleListResponse], error)

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

Assign project role to user

client.Admin.Organization.Projects.Users.Roles.New(ctx, projectID, userID, body) (*AdminOrganizationProjectUserRoleNewResponse, error)

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

Retrieve project user role

client.Admin.Organization.Projects.Users.Roles.Get(ctx, projectID, userID, roleID) (*AdminOrganizationProjectUserRoleGetResponse, error)

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

Unassign project role from user

client.Admin.Organization.Projects.Users.Roles.Delete(ctx, projectID, userID, roleID) (*AdminOrganizationProjectUserRoleDeleteResponse, error)

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

AdminOrganizationProjectsService Accounts

List project service accounts

client.Admin.Organization.Projects.ServiceAccounts.List(ctx, projectID, query) (*ConversationCursorPage[ProjectServiceAccount], error)

GET/organization/projects/{project_id}/service_accounts

Create project service account

client.Admin.Organization.Projects.ServiceAccounts.New(ctx, projectID, body) (*AdminOrganizationProjectServiceAccountNewResponse, error)

POST/organization/projects/{project_id}/service_accounts

Retrieve project service account

client.Admin.Organization.Projects.ServiceAccounts.Get(ctx, projectID, serviceAccountID) (*ProjectServiceAccount, error)

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

Update project service account

client.Admin.Organization.Projects.ServiceAccounts.Update(ctx, projectID, serviceAccountID, body) (*ProjectServiceAccount, error)

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

Delete project service account

client.Admin.Organization.Projects.ServiceAccounts.Delete(ctx, projectID, serviceAccountID) (*AdminOrganizationProjectServiceAccountDeleteResponse, error)

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

ModelsExpand Collapse

type ProjectServiceAccount struct{…}

Represents an individual service account in a project.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the service account was created

formatunixtime

Name string

The name of the service account

Object OrganizationProjectServiceAccount

The object type, which is always organization.project.service_account

Role ProjectServiceAccountRole

owner or member

One of the following:

const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"

const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"

AdminOrganizationProjectsAPI Keys

List project API keys

client.Admin.Organization.Projects.APIKeys.List(ctx, projectID, query) (*ConversationCursorPage[ProjectAPIKey], error)

GET/organization/projects/{project_id}/api_keys

Retrieve project API key

client.Admin.Organization.Projects.APIKeys.Get(ctx, projectID, apiKeyID) (*ProjectAPIKey, error)

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

Delete project API key

client.Admin.Organization.Projects.APIKeys.Delete(ctx, projectID, apiKeyID) (*AdminOrganizationProjectAPIKeyDeleteResponse, error)

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

ModelsExpand Collapse

type ProjectAPIKey struct{…}

Represents an individual API key in a project.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the API key was created

formatunixtime

LastUsedAt int64

The Unix timestamp (in seconds) of when the API key was last used.

formatunixtime

Name string

The name of the API key

Object OrganizationProjectAPIKey

The object type, which is always organization.project.api_key

Owner ProjectAPIKeyOwner

ServiceAccount ProjectAPIKeyOwnerServiceAccountOptional

The service account that owns a project API key.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the service account was created.

formatunixtime

Name string

The name of the service account.

Role string

The service account’s project role.

Type stringOptional

user or service_account

One of the following:

const ProjectAPIKeyOwnerTypeUser ProjectAPIKeyOwnerType = "user"

const ProjectAPIKeyOwnerTypeServiceAccount ProjectAPIKeyOwnerType = "service_account"

User ProjectAPIKeyOwnerUserOptional

The user that owns a project API key.

ID string

The identifier, which can be referenced in API endpoints

CreatedAt int64

The Unix timestamp (in seconds) of when the user was created.

formatunixtime

Email string

The email address of the user.

Name string

The name of the user.

Role string

The user’s project role.

RedactedValue string

The redacted value of the API key

AdminOrganizationProjectsRate Limits

List project rate limits

client.Admin.Organization.Projects.RateLimits.ListRateLimits(ctx, projectID, query) (*ConversationCursorPage[ProjectRateLimit], error)

GET/organization/projects/{project_id}/rate_limits

Modify project rate limit

client.Admin.Organization.Projects.RateLimits.UpdateRateLimit(ctx, projectID, rateLimitID, body) (*ProjectRateLimit, error)

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

ModelsExpand Collapse

type ProjectRateLimit struct{…}

Represents a project rate limit config.

ID string

The identifier, which can be referenced in API endpoints.

MaxRequestsPer1Minute int64

The maximum requests per minute.

MaxTokensPer1Minute int64

The maximum tokens per minute.

Model string

The model this rate limit applies to.

Object ProjectRateLimit

The object type, which is always project.rate_limit

Batch1DayMaxInputTokens int64Optional

The maximum batch input tokens per day. Only present for relevant models.

MaxAudioMegabytesPer1Minute int64Optional

The maximum audio megabytes per minute. Only present for relevant models.

MaxImagesPer1Minute int64Optional

The maximum images per minute. Only present for relevant models.

MaxRequestsPer1Day int64Optional

The maximum requests per day. Only present for relevant models.

AdminOrganizationProjectsModel Permissions

Retrieve project model permissions

client.Admin.Organization.Projects.ModelPermissions.Get(ctx, projectID) (*ProjectModelPermissions, error)

GET/organization/projects/{project_id}/model_permissions

Modify project model permissions

client.Admin.Organization.Projects.ModelPermissions.Update(ctx, projectID, body) (*ProjectModelPermissions, error)

POST/organization/projects/{project_id}/model_permissions

Delete project model permissions

client.Admin.Organization.Projects.ModelPermissions.Delete(ctx, projectID) (*ProjectModelPermissionsDeleted, error)

DELETE/organization/projects/{project_id}/model_permissions

ModelsExpand Collapse

type ProjectModelPermissions struct{…}

Represents the model allowlist or denylist policy for a project.

Mode ProjectModelPermissionsMode

Whether the project uses an allowlist or a denylist.

One of the following:

const ProjectModelPermissionsModeAllowList ProjectModelPermissionsMode = "allow_list"

const ProjectModelPermissionsModeDenyList ProjectModelPermissionsMode = "deny_list"

ModelIDs []string

The model IDs included in the model permissions policy.

Object ProjectModelPermissions

The object type, which is always project.model_permissions.

type ProjectModelPermissionsDeleted struct{…}

Confirmation payload returned after deleting project model permissions.

Deleted bool

Whether the project model permissions were deleted.

Object ProjectModelPermissionsDeleted

The object type, which is always project.model_permissions.deleted.

AdminOrganizationProjectsHosted Tool Permissions

Retrieve project hosted tool permissions

client.Admin.Organization.Projects.HostedToolPermissions.Get(ctx, projectID) (*ProjectHostedToolPermissions, error)

GET/organization/projects/{project_id}/hosted_tool_permissions

Modify project hosted tool permissions

client.Admin.Organization.Projects.HostedToolPermissions.Update(ctx, projectID, body) (*ProjectHostedToolPermissions, error)

POST/organization/projects/{project_id}/hosted_tool_permissions

ModelsExpand Collapse

type ProjectHostedToolPermissions struct{…}

Represents hosted tool permissions for a project.

CodeInterpreter ProjectHostedToolPermissionsCodeInterpreter

Permission state for a single hosted tool on a project.

Enabled bool

Whether the hosted tool is enabled for the project.

FileSearch ProjectHostedToolPermissionsFileSearch

Permission state for a single hosted tool on a project.

Enabled bool

Whether the hosted tool is enabled for the project.

ImageGeneration ProjectHostedToolPermissionsImageGeneration

Permission state for a single hosted tool on a project.

Enabled bool

Whether the hosted tool is enabled for the project.

Mcp ProjectHostedToolPermissionsMcp

Permission state for a single hosted tool on a project.

Enabled bool

Whether the hosted tool is enabled for the project.

WebSearch ProjectHostedToolPermissionsWebSearch

Permission state for a single hosted tool on a project.

Enabled bool

Whether the hosted tool is enabled for the project.

AdminOrganizationProjectsGroups

List project groups

client.Admin.Organization.Projects.Groups.List(ctx, projectID, query) (*NextCursorPage[ProjectGroup], error)

GET/organization/projects/{project_id}/groups

Add project group

client.Admin.Organization.Projects.Groups.New(ctx, projectID, body) (*ProjectGroup, error)

POST/organization/projects/{project_id}/groups

Retrieve project group

client.Admin.Organization.Projects.Groups.Get(ctx, projectID, groupID, query) (*ProjectGroup, error)

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

Remove project group

client.Admin.Organization.Projects.Groups.Delete(ctx, projectID, groupID) (*AdminOrganizationProjectGroupDeleteResponse, error)

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

ModelsExpand Collapse

type ProjectGroup struct{…}

Details about a group’s membership in a project.

CreatedAt int64

Unix timestamp (in seconds) when the group was granted project access.

formatunixtime

GroupID string

Identifier of the group that has access to the project.

GroupName string

Display name of the group.

GroupType ProjectGroupGroupType

The type of the group.

One of the following:

const ProjectGroupGroupTypeGroup ProjectGroupGroupType = "group"

const ProjectGroupGroupTypeTenantGroup ProjectGroupGroupType = "tenant_group"

Object ProjectGroup

Always project.group.

ProjectID string

Identifier of the project.

AdminOrganizationProjectsGroupsRoles

List project group role assignments

client.Admin.Organization.Projects.Groups.Roles.List(ctx, projectID, groupID, query) (*NextCursorPage[AdminOrganizationProjectGroupRoleListResponse], error)

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

Assign project role to group

client.Admin.Organization.Projects.Groups.Roles.New(ctx, projectID, groupID, body) (*AdminOrganizationProjectGroupRoleNewResponse, error)

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

Retrieve project group role

client.Admin.Organization.Projects.Groups.Roles.Get(ctx, projectID, groupID, roleID) (*AdminOrganizationProjectGroupRoleGetResponse, error)

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

Unassign project role from group

client.Admin.Organization.Projects.Groups.Roles.Delete(ctx, projectID, groupID, roleID) (*AdminOrganizationProjectGroupRoleDeleteResponse, error)

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

AdminOrganizationProjectsRoles

List project roles

client.Admin.Organization.Projects.Roles.List(ctx, projectID, query) (*NextCursorPage[Role], error)

GET/projects/{project_id}/roles

Create project role

client.Admin.Organization.Projects.Roles.New(ctx, projectID, body) (*Role, error)

POST/projects/{project_id}/roles

Retrieve project role

client.Admin.Organization.Projects.Roles.Get(ctx, projectID, roleID) (*Role, error)

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

Update project role

client.Admin.Organization.Projects.Roles.Update(ctx, projectID, roleID, body) (*Role, error)

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

Delete project role

client.Admin.Organization.Projects.Roles.Delete(ctx, projectID, roleID) (*AdminOrganizationProjectRoleDeleteResponse, error)

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

AdminOrganizationProjectsData Retention

Retrieve project data retention

client.Admin.Organization.Projects.DataRetention.Get(ctx, projectID) (*ProjectDataRetention, error)

GET/organization/projects/{project_id}/data_retention

Update project data retention

client.Admin.Organization.Projects.DataRetention.Update(ctx, projectID, body) (*ProjectDataRetention, error)

POST/organization/projects/{project_id}/data_retention

ModelsExpand Collapse

type ProjectDataRetention struct{…}

Represents a project’s data retention control setting.

Object ProjectDataRetention

The object type, which is always project.data_retention.

Type ProjectDataRetentionType

The configured project data retention type.

One of the following:

const ProjectDataRetentionTypeOrganizationDefault ProjectDataRetentionType = "organization_default"

const ProjectDataRetentionTypeNone ProjectDataRetentionType = "none"

const ProjectDataRetentionTypeZeroDataRetention ProjectDataRetentionType = "zero_data_retention"

const ProjectDataRetentionTypeModifiedAbuseMonitoring ProjectDataRetentionType = "modified_abuse_monitoring"

const ProjectDataRetentionTypeEnhancedZeroDataRetention ProjectDataRetentionType = "enhanced_zero_data_retention"

const ProjectDataRetentionTypeEnhancedModifiedAbuseMonitoring ProjectDataRetentionType = "enhanced_modified_abuse_monitoring"

AdminOrganizationProjectsSpend Alerts

List project spend alerts

client.Admin.Organization.Projects.SpendAlerts.List(ctx, projectID, query) (*ConversationCursorPage[ProjectSpendAlert], error)

GET/organization/projects/{project_id}/spend_alerts

Create project spend alert

client.Admin.Organization.Projects.SpendAlerts.New(ctx, projectID, body) (*ProjectSpendAlert, error)

POST/organization/projects/{project_id}/spend_alerts

Update project spend alert

client.Admin.Organization.Projects.SpendAlerts.Update(ctx, projectID, alertID, body) (*ProjectSpendAlert, error)

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

Delete project spend alert

client.Admin.Organization.Projects.SpendAlerts.Delete(ctx, projectID, alertID) (*ProjectSpendAlertDeleted, error)

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

ModelsExpand Collapse

type ProjectSpendAlert struct{…}

Represents a spend alert configured at the project level.

ID string

The identifier, which can be referenced in API endpoints.

Currency ProjectSpendAlertCurrency

The currency for the threshold amount.

Interval ProjectSpendAlertInterval

The time interval for evaluating spend against the threshold.

NotificationChannel ProjectSpendAlertNotificationChannel

Email notification settings for a spend alert.

Recipients []string

Email addresses that receive the spend alert notification.

Type Email

The notification channel type. Currently only email is supported.

SubjectPrefix stringOptional

Optional subject prefix for alert emails.

Object ProjectSpendAlert

The object type, which is always project.spend_alert.

ThresholdAmount int64

The alert threshold amount, in cents.

type ProjectSpendAlertDeleted struct{…}

Confirmation payload returned after deleting a project spend alert.

ID string

The deleted spend alert ID.

Deleted bool

Whether the spend alert was deleted.

Object ProjectSpendAlertDeleted

Always project.spend_alert.deleted.

AdminOrganizationProjectsCertificates

List project certificates

client.Admin.Organization.Projects.Certificates.List(ctx, projectID, query) (*ConversationCursorPage[AdminOrganizationProjectCertificateListResponse], error)

GET/organization/projects/{project_id}/certificates

Activate certificates for project

client.Admin.Organization.Projects.Certificates.Activate(ctx, projectID, body) (*Page[AdminOrganizationProjectCertificateActivateResponse], error)

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

Deactivate certificates for project

client.Admin.Organization.Projects.Certificates.Deactivate(ctx, projectID, body) (*Page[AdminOrganizationProjectCertificateDeactivateResponse], error)

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