Organization

OrganizationAudit Logs

List audit logs

GET/organization/audit_logs

Costs

GET/organization/costs

OrganizationAudit LogsAdmin API Keys

List all organization and project API keys.

GET/organization/admin_api_keys

Create admin API key

POST/organization/admin_api_keys

Retrieve admin API key

GET/organization/admin_api_keys/{key_id}

Delete admin API key

DELETE/organization/admin_api_keys/{key_id}

OrganizationAudit LogsUsage

Audio speeches

GET/organization/usage/audio_speeches

Audio transcriptions

GET/organization/usage/audio_transcriptions

Code interpreter sessions

GET/organization/usage/code_interpreter_sessions

Completions

GET/organization/usage/completions

Embeddings

GET/organization/usage/embeddings

Images

GET/organization/usage/images

Moderations

GET/organization/usage/moderations

Vector stores

GET/organization/usage/vector_stores

OrganizationInvites

List invites

GET/organization/invites

Create invite

POST/organization/invites

Retrieve invite

GET/organization/invites/{invite_id}

Delete invite

DELETE/organization/invites/{invite_id}

ModelsExpand Collapse

Invite = object { id, email, expires_at, 6 more }

Represents an individual invite to the organization.

id: string

The identifier, which can be referenced in API endpoints

email: string

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

expires_at: number

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

invited_at: number

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

object: "organization.invite"

The object type, which is always organization.invite

role: "owner" or "reader"

owner or reader

Accepts one of the following:

"owner"

"reader"

status: "accepted" or "expired" or "pending"

accepted,expired, or pending

Accepts one of the following:

"accepted"

"expired"

"pending"

accepted_at: optional number

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

projects: optional array of object { id, role }

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

id: optional string

Project's public ID

role: optional "member" or "owner"

Project membership role

Accepts one of the following:

"member"

"owner"

OrganizationUsers

List users

GET/organization/users

Retrieve user

GET/organization/users/{user_id}

Modify user

POST/organization/users/{user_id}

Delete user

DELETE/organization/users/{user_id}

ModelsExpand Collapse

User = object { id, added_at, email, 3 more }

Represents an individual user within an organization.

id: string

The identifier, which can be referenced in API endpoints

added_at: number

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

email: string

The email address of the user

The name of the user

object: "organization.user"

The object type, which is always organization.user

role: "owner" or "reader"

owner or reader

Accepts one of the following:

"owner"

"reader"

OrganizationUsersRoles

List user organization role assignments

GET/organization/users/{user_id}/roles

Assign organization role to user

POST/organization/users/{user_id}/roles

Unassign organization role from user

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

OrganizationGroups

List groups

GET/organization/groups

Create group

POST/organization/groups

Update group

POST/organization/groups/{group_id}

Delete group

DELETE/organization/groups/{group_id}

OrganizationGroupsUsers

List group users

GET/organization/groups/{group_id}/users

Add group user

POST/organization/groups/{group_id}/users

Remove group user

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

OrganizationGroupsRoles

List group organization role assignments

GET/organization/groups/{group_id}/roles

Assign organization role to group

POST/organization/groups/{group_id}/roles

Unassign organization role from group

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

OrganizationRoles

List organization roles

GET/organization/roles

Create organization role

POST/organization/roles

Update organization role

POST/organization/roles/{role_id}

Delete organization role

DELETE/organization/roles/{role_id}

OrganizationCertificates

List organization certificates

GET/organization/certificates

Upload certificate

POST/organization/certificates

Get certificate

GET/organization/certificates/{certificate_id}

Modify certificate

POST/organization/certificates/{certificate_id}

Delete certificate

DELETE/organization/certificates/{certificate_id}

Activate certificates for organization

POST/organization/certificates/activate

Deactivate certificates for organization

POST/organization/certificates/deactivate

OrganizationProjects

List projects

GET/organization/projects

Create project

POST/organization/projects

Retrieve project

GET/organization/projects/{project_id}

Modify project

POST/organization/projects/{project_id}

Archive project

POST/organization/projects/{project_id}/archive

ModelsExpand Collapse

Project = object { id, created_at, name, 3 more }

Represents an individual project.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

The name of the project. This appears in reporting.

object: "organization.project"

The object type, which is always organization.project

status: "active" or "archived"

active or archived

Accepts one of the following:

"active"

"archived"

archived_at: optional number

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

OrganizationProjectsUsers

List project users

GET/organization/projects/{project_id}/users

Create project user

POST/organization/projects/{project_id}/users

Retrieve project user

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

Modify project user

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

Delete project user

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

ModelsExpand Collapse

ProjectUser = object { id, added_at, email, 3 more }

Represents an individual user in a project.

id: string

The identifier, which can be referenced in API endpoints

added_at: number

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

email: string

The email address of the user

The name of the user

object: "organization.project.user"

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

role: "owner" or "member"

owner or member

Accepts one of the following:

"owner"

"member"

OrganizationProjectsService Accounts

List project service accounts

GET/organization/projects/{project_id}/service_accounts

Create project service account

POST/organization/projects/{project_id}/service_accounts

Retrieve project service account

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

Delete project service account

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

ModelsExpand Collapse

ProjectServiceAccount = object { id, created_at, name, 2 more }

Represents an individual service account in a project.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

The name of the service account

object: "organization.project.service_account"

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

role: "owner" or "member"

owner or member

Accepts one of the following:

"owner"

"member"

OrganizationProjectsAPI Keys

List project API keys

GET/organization/projects/{project_id}/api_keys

Retrieve project API key

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

Delete project API key

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

ModelsExpand Collapse

ProjectAPIEy = object { id, created_at, last_used_at, 4 more }

Represents an individual API key in a project.

id: string

The identifier, which can be referenced in API endpoints

created_at: number

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

last_used_at: number

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

The name of the API key

object: "organization.project.api_key"

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

owner: object { service_account, type, user }

service_account: optional ProjectServiceAccount { id, created_at, name, 2 more }

Represents an individual service account in a project.

type: optional "user" or "service_account"

user or service_account

Accepts one of the following:

"user"

"service_account"

user: optional ProjectUser { id, added_at, email, 3 more }

Represents an individual user in a project.

redacted_value: string

The redacted value of the API key

OrganizationProjectsRate Limits

List project rate limits

GET/organization/projects/{project_id}/rate_limits

Modify project rate limit

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

OrganizationProjectsGroups

List project groups

GET/organization/projects/{project_id}/groups

Add project group

POST/organization/projects/{project_id}/groups

Remove project group

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

OrganizationProjectsCertificates

List project certificates

GET/organization/projects/{project_id}/certificates

Activate certificates for project

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

Deactivate certificates for project

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