🛡️ Admin

⋙ List Organization Audit Logs

List organization audit logs.

effective_at object: Optional timestamp filter object.
project_ids array: Optional project ids to filter by.
actor_ids array: Optional actor ids to filter by.
event_types array: Optional audit event names to include, such as workload_identity_provider.created, workload_identity_provider.updated, workload_identity_provider.deleted, workload_identity_provider_mapping.created, workload_identity_provider_mapping.updated, and workload_identity_provider_mapping.deleted.
limit integer: Maximum number of audit log entries to return.

Audit log entries are returned with their full SDK event detail objects, including workload identity provider and provider-mapping details.

⋙ Create Organization Admin API Key

Create an organization Admin API key.

name string: Optional label for the new Admin API key.

⋙ Retrieve Organization Admin API Key

Retrieve an organization Admin API key by id.

key_id string: The Admin API key id.

⋙ List Organization Admin API Keys

List organization Admin API keys.

after string: Pagination cursor for keys after this id.
limit integer: Maximum number of keys to return.

⋙ Delete Organization Admin API Key

Delete an organization Admin API key by id.

key_id string: The Admin API key id.

⋙ Retrieve Organization Usage Audio Speeches

Retrieve organization usage for audio speech generation.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Audio Transcriptions

Retrieve organization usage for audio transcriptions.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Code Interpreter Sessions

Retrieve organization usage for code interpreter sessions.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Completions

Retrieve organization usage for completions.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
project_ids array: Optional project ids to include.
user_ids array: Optional user ids to include.
api_key_ids array: Optional API key ids to include.
group_by array: Optional dimensions to group by.

⋙ Retrieve Organization Costs

Retrieve organization cost data.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1d.

⋙ Retrieve Organization Usage Embeddings

Retrieve organization usage for embeddings.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage File Search Calls

Retrieve organization usage for file search calls.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.
project_ids array: Optional project ids to include.
group_by array: Optional dimensions to group by.

⋙ Retrieve Organization Usage Images

Retrieve organization usage for images.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Moderations

Retrieve organization usage for moderations.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Vector Stores

Retrieve organization usage for vector stores.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.

⋙ Retrieve Organization Usage Web Search Calls

Retrieve organization usage for web search calls.

start_time integer: Inclusive Unix timestamp for the start of the reporting window.
end_time integer: Exclusive Unix timestamp for the end of the reporting window.
bucket_width string: Bucket size such as 1m, 1h, or 1d.
project_ids array: Optional project ids to include.
group_by array: Optional dimensions to group by.

⋙ Retrieve Organization Data Retention

Retrieve organization data retention controls.

msg.payload Properties

No payload properties are required.

⋙ Modify Organization Data Retention

Update organization data retention controls.

retention_type string: The organization retention mode to apply.

⋙ Create Organization Spend Alert

Create an organization spend alert.

currency string: The threshold currency, currently USD.
interval string: The spend evaluation interval, currently month.
notification_channel object: Email notification settings with type and recipients.
threshold_amount integer: The alert threshold amount in cents.

⋙ Modify Organization Spend Alert

Update an organization spend alert.

alert_id string: The spend alert id.
currency string: The threshold currency, currently USD.
interval string: The spend evaluation interval, currently month.
notification_channel object: Email notification settings with type and recipients.
threshold_amount integer: The alert threshold amount in cents.

⋙ List Organization Spend Alerts

List organization spend alerts.

before string: Pagination cursor for alerts before this id.
limit integer: Maximum number of alerts to return.
order string: Sort order for returned alerts.

⋙ Delete Organization Spend Alert

Delete an organization spend alert.

alert_id string: The spend alert id.

⋙ Create Organization Invite

Create an organization invite.

email string: The email address to invite.
role string: Optional organization role to assign with the invite.

⋙ Retrieve Organization Invite

Retrieve an organization invite by id.

invite_id string: The invite id.

⋙ List Organization Invites

List organization invites.

after string: Pagination cursor for invites after this id.
limit integer: Maximum number of invites to return.

⋙ Delete Organization Invite

Delete an organization invite by id.

invite_id string: The invite id.

⋙ Retrieve Organization User

Retrieve an organization user by id.

user_id string: The user id.

⋙ Modify Organization User

Update mutable fields for an organization user.

user_id string: The user id.
role string: Optional updated role or other mutable fields supported by the API.

⋙ List Organization Users

List organization users.

after string: Pagination cursor for users after this id.
limit integer: Maximum number of users to return.

⋙ Delete Organization User

Delete an organization user by id.

user_id string: The user id.

⋙ Create Organization User Role

Create a role assignment for an organization user.

user_id string: The user id.
role string: The role to assign.

⋙ Retrieve Organization User Role

Retrieve a role assignment for an organization user.

role_id string: The role assignment id.
user_id string: The user id that owns the assignment.

⋙ List Organization User Roles

List role assignments for an organization user.

user_id string: The user id.
after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Organization User Role

Delete a role assignment from an organization user.

user_id string: The user id.
role_id string: The role assignment id.

⋙ Create Organization Group

Create an organization group.

name string: The group name.

⋙ Retrieve Organization Group

Retrieve an organization group by id.

group_id string: The group id.

⋙ Modify Organization Group

Update an organization group.

group_id string: The group id.
name string: Updated group name.

⋙ List Organization Groups

List organization groups.

after string: Pagination cursor for groups after this id.
limit integer: Maximum number of groups to return.

⋙ Delete Organization Group

Delete an organization group by id.

group_id string: The group id.

⋙ Create Organization Group User

Add a user to an organization group.

group_id string: The group id.
user_id string: The user id to add.

⋙ Retrieve Organization Group User

Retrieve a user in an organization group.

user_id string: The user id to retrieve.
group_id string: The group id to inspect.

⋙ List Organization Group Users

List users in an organization group.

group_id string: The group id.
after string: Pagination cursor for users after this id.
limit integer: Maximum number of users to return.

⋙ Delete Organization Group User

Remove a user from an organization group.

group_id string: The group id.
user_id string: The user id to remove.

⋙ Create Organization Group Role

Create a role assignment for an organization group.

group_id string: The group id.
role string: The role to assign.

⋙ Retrieve Organization Group Role

Retrieve a role assignment for an organization group.

role_id string: The role assignment id.
group_id string: The group id that owns the assignment.

⋙ List Organization Group Roles

List role assignments for an organization group.

group_id string: The group id.
after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Organization Group Role

Delete a role assignment from an organization group.

group_id string: The group id.
role_id string: The role assignment id.

⋙ Create Organization Role

Create an organization role.

role string: The role name to create.

⋙ Retrieve Organization Role

Retrieve an organization role by id.

role_id string: The role id.

⋙ Modify Organization Role

Update an organization role.

role_id string: The role id.

⋙ List Organization Roles

List organization roles.

after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Organization Role

Delete an organization role by id.

role_id string: The role id.

⋙ Create Organization Certificate

Create an organization certificate.

certificate string: The certificate content or reference required by the API.

⋙ Retrieve Organization Certificate

Retrieve an organization certificate by id.

certificate_id string: The certificate id.

⋙ Modify Organization Certificate

Update an organization certificate.

certificate_id string: The certificate id.

⋙ List Organization Certificates

List organization certificates.

after string: Pagination cursor for certificates after this id.
limit integer: Maximum number of certificates to return.

⋙ Delete Organization Certificate

Delete an organization certificate by id.

certificate_id string: The certificate id.

⋙ Activate Organization Certificates

Activate organization certificates.

certificate_ids array: Certificate ids to activate.

⋙ Deactivate Organization Certificates

Deactivate organization certificates.

certificate_ids array: Certificate ids to deactivate.

⋙ Create Organization Project

Create an organization project.

name string: The project name.

⋙ Retrieve Organization Project

Retrieve an organization project by id.

project_id string: The project id.

⋙ Modify Organization Project

Update mutable fields for an organization project.

project_id string: The project id.
name string: Updated project name.

⋙ List Organization Projects

List organization projects.

after string: Pagination cursor for projects after this id.
limit integer: Maximum number of projects to return.
include_archived boolean: Whether to include archived projects.

⋙ Archive Organization Project

Archive an organization project by id.

project_id string: The project id.

⋙ Retrieve Project Data Retention

Retrieve data retention controls for a project.

project_id string: The project id.

⋙ Modify Project Data Retention

Update data retention controls for a project.

project_id string: The project id.
retention_type string: The project retention mode to apply.

⋙ Create Project Spend Alert

Create a spend alert for a project.

project_id string: The project id.
currency string: The threshold currency, currently USD.
interval string: The spend evaluation interval, currently month.
notification_channel object: Email notification settings with type and recipients.
threshold_amount integer: The alert threshold amount in cents.

⋙ Modify Project Spend Alert

Update a spend alert for a project.

alert_id string: The spend alert id.
project_id string: The project id.
currency string: The threshold currency, currently USD.
interval string: The spend evaluation interval, currently month.
notification_channel object: Email notification settings with type and recipients.
threshold_amount integer: The alert threshold amount in cents.

⋙ List Project Spend Alerts

List spend alerts for a project.

project_id string: The project id.
before string: Pagination cursor for alerts before this id.
limit integer: Maximum number of alerts to return.
order string: Sort order for returned alerts.

⋙ Delete Project Spend Alert

Delete a spend alert for a project.

alert_id string: The spend alert id.
project_id string: The project id.

⋙ Retrieve Project Model Permissions

Retrieve model permissions for a project.

project_id string: The project id.

⋙ Modify Project Model Permissions

Update model permissions for a project.

project_id string: The project id.
mode string: The model permission mode, such as allow_list or deny_list.
model_ids array: The model ids included in the permission policy.

⋙ Delete Project Model Permissions

Delete model permissions for a project.

project_id string: The project id.

⋙ Retrieve Project Hosted Tool Permissions

Retrieve hosted tool permissions for a project.

project_id string: The project id.

⋙ Modify Project Hosted Tool Permissions

Update hosted tool permissions for a project.

project_id string: The project id.
code_interpreter object: Optional hosted tool permission object with an enabled boolean.
file_search object: Optional hosted tool permission object with an enabled boolean.
image_generation object: Optional hosted tool permission object with an enabled boolean.
mcp object: Optional hosted tool permission object with an enabled boolean.
web_search object: Optional hosted tool permission object with an enabled boolean.

⋙ Retrieve Project API Key

Retrieve a project API key by id.

project_id string: The project id.
api_key_id string: The project API key id.

⋙ List Project API Keys

List API keys for a project.

project_id string: The project id.
after string: Pagination cursor for keys after this id.
limit integer: Maximum number of keys to return.

⋙ Delete Project API Key

Delete a project API key by id.

project_id string: The project id.
api_key_id string: The project API key id.

⋙ List Project Certificates

List certificates for a project.

project_id string: The project id.
after string: Pagination cursor for certificates after this id.
limit integer: Maximum number of certificates to return.

⋙ Activate Project Certificates

Activate certificates for a project.

project_id string: The project id.
certificate_ids array: Certificate ids to activate.

⋙ Deactivate Project Certificates

Deactivate certificates for a project.

project_id string: The project id.
certificate_ids array: Certificate ids to deactivate.

⋙ Create Project Service Account

Create a service account for a project.

project_id string: The project id.
name string: Optional service account name.

⋙ Retrieve Project Service Account

Retrieve a project service account by id.

project_id string: The project id.
service_account_id string: The service account id.

⋙ Modify Project Service Account

Update a project service account by id.

service_account_id string: The service account id.
project_id string: The project id.
name string: Updated service account name.
role string: Updated service account role.

⋙ List Project Service Accounts

List service accounts for a project.

project_id string: The project id.
after string: Pagination cursor for service accounts after this id.
limit integer: Maximum number of service accounts to return.

⋙ Delete Project Service Account

Delete a project service account by id.

project_id string: The project id.
service_account_id string: The service account id.

⋙ Create Project User

Add a user to a project.

project_id string: The project id.
user_id string: The user id to add.

⋙ Retrieve Project User

Retrieve a project user by id.

project_id string: The project id.
user_id string: The project user id.

⋙ Modify Project User

Update a project user.

project_id string: The project id.
user_id string: The project user id.

⋙ List Project Users

List users in a project.

project_id string: The project id.
after string: Pagination cursor for users after this id.
limit integer: Maximum number of users to return.

⋙ Delete Project User

Remove a user from a project.

project_id string: The project id.
user_id string: The project user id.

⋙ Create Project User Role

Create a role assignment for a project user.

project_id string: The project id.
user_id string: The project user id.
role string: The role to assign.

⋙ Retrieve Project User Role

Retrieve a role assignment for a project user.

role_id string: The role assignment id.
project_id string: The project id.
user_id string: The project user id that owns the assignment.

⋙ List Project User Roles

List role assignments for a project user.

project_id string: The project id.
user_id string: The project user id.
after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Project User Role

Delete a role assignment from a project user.

project_id string: The project id.
user_id string: The project user id.
role_id string: The role assignment id.

⋙ Create Project Group

Add a group to a project.

project_id string: The project id.
group_id string: The group id to add.

⋙ Retrieve Project Group

Retrieve a group that has access to a project.

group_id string: The group id.
project_id string: The project id.
group_type string: Optional group type to retrieve.

⋙ List Project Groups

List groups in a project.

project_id string: The project id.
after string: Pagination cursor for groups after this id.
limit integer: Maximum number of groups to return.

⋙ Delete Project Group

Remove a group from a project.

project_id string: The project id.
group_id string: The group id to remove.

⋙ Create Project Group Role

Create a role assignment for a project group.

project_id string: The project id.
group_id string: The group id.
role string: The role to assign.

⋙ Retrieve Project Group Role

Retrieve a role assignment for a project group.

role_id string: The role assignment id.
project_id string: The project id.
group_id string: The project group id that owns the assignment.

⋙ List Project Group Roles

List role assignments for a project group.

project_id string: The project id.
group_id string: The group id.
after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Project Group Role

Delete a role assignment from a project group.

project_id string: The project id.
group_id string: The group id.
role_id string: The role assignment id.

⋙ Create Project Role

Create a project role.

project_id string: The project id.
role string: The role to create.

⋙ Retrieve Project Role

Retrieve a project role by id.

role_id string: The role id.
project_id string: The project id.

⋙ Modify Project Role

Update a project role.

project_id string: The project id.
role_id string: The role id.

⋙ List Project Roles

List project roles.

project_id string: The project id.
after string: Pagination cursor for roles after this id.
limit integer: Maximum number of roles to return.

⋙ Delete Project Role

Delete a project role by id.

project_id string: The project id.
role_id string: The role id.

⋙ List Project Rate Limits

List project rate limits.

project_id string: The project id.

⋙ Modify Project Rate Limit

Update a project rate limit by id.

project_id string: The project id.
rate_limit_id string: The rate limit id.