> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# openai-admin
> OpenAI Admin - projects, users, invites, certificates, usage, and audit logs
**Server path:** `/openai-admin` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`openai_admin_activate_organization_certificates`](#openai_admin_activate_organization_certificates) | Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time. |
| [`openai_admin_activate_project_certificates`](#openai_admin_activate_project_certificates) | Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time. |
| [`openai_admin_archive_project`](#openai_admin_archive_project) | Archives a project in the organization. Archived projects cannot be used or updated. |
| [`openai_admin_create_project`](#openai_admin_create_project) | Create a new project in the organization. Projects can be created and archived, but cannot be deleted. |
| [`openai_admin_create_project_service_account`](#openai_admin_create_project_service_account) | Creates a new service account in the project. This also returns an unredacted API key for the service account. |
| [`openai_admin_create_project_user`](#openai_admin_create_project_user) | Adds a user to the project. Users must already be members of the organization to be added to a project. |
| [`openai_admin_deactivate_organization_certificates`](#openai_admin_deactivate_organization_certificates) | Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time. |
| [`openai_admin_deactivate_project_certificates`](#openai_admin_deactivate_project_certificates) | Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time. |
| [`openai_admin_delete_certificate`](#openai_admin_delete_certificate) | Delete a certificate from the organization. The certificate must be inactive for the organization and all projects. |
| [`openai_admin_delete_invite`](#openai_admin_delete_invite) | Delete an invite. If the invite has already been accepted, it cannot be deleted. |
| [`openai_admin_delete_project_api_key`](#openai_admin_delete_project_api_key) | Deletes an API key from the project. |
| [`openai_admin_delete_project_service_account`](#openai_admin_delete_project_service_account) | Deletes a service account from the project. |
| [`openai_admin_delete_project_user`](#openai_admin_delete_project_user) | Deletes a user from the project. |
| [`openai_admin_delete_user`](#openai_admin_delete_user) | Deletes a user from the organization. |
| [`openai_admin_get_certificate`](#openai_admin_get_certificate) | Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not. |
| [`openai_admin_invite_user`](#openai_admin_invite_user) | Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization. |
| [`openai_admin_list_audit_logs`](#openai_admin_list_audit_logs) | List user actions and configuration changes within this organization. |
| [`openai_admin_list_invites`](#openai_admin_list_invites) | Returns a list of invites in the organization. |
| [`openai_admin_list_organization_certificates`](#openai_admin_list_organization_certificates) | List uploaded certificates for this organization. |
| [`openai_admin_list_project_api_keys`](#openai_admin_list_project_api_keys) | Returns a list of API keys in the project. |
| [`openai_admin_list_project_certificates`](#openai_admin_list_project_certificates) | List certificates for this project. |
| [`openai_admin_list_project_rate_limits`](#openai_admin_list_project_rate_limits) | Returns the rate limits per model for a project. |
| [`openai_admin_list_project_service_accounts`](#openai_admin_list_project_service_accounts) | Returns a list of service accounts in the project. |
| [`openai_admin_list_project_users`](#openai_admin_list_project_users) | Returns a list of users in the project. |
| [`openai_admin_list_projects`](#openai_admin_list_projects) | Returns a list of projects. |
| [`openai_admin_list_users`](#openai_admin_list_users) | Lists all of the users in the organization. |
| [`openai_admin_modify_certificate`](#openai_admin_modify_certificate) | Modify a certificate. Note that only the name can be modified. |
| [`openai_admin_modify_project`](#openai_admin_modify_project) | Modifies a project in the organization. |
| [`openai_admin_modify_project_user`](#openai_admin_modify_project_user) | Modifies a user's role in the project. |
| [`openai_admin_modify_user`](#openai_admin_modify_user) | Modifies a user's role in the organization. |
| [`openai_admin_retrieve_invite`](#openai_admin_retrieve_invite) | Retrieves an invite. |
| [`openai_admin_retrieve_project`](#openai_admin_retrieve_project) | Retrieves a project. |
| [`openai_admin_retrieve_project_api_key`](#openai_admin_retrieve_project_api_key) | Retrieves an API key in the project. |
| [`openai_admin_retrieve_project_service_account`](#openai_admin_retrieve_project_service_account) | Retrieves a service account in the project. |
| [`openai_admin_retrieve_project_user`](#openai_admin_retrieve_project_user) | Retrieves a user in the project. |
| [`openai_admin_retrieve_user`](#openai_admin_retrieve_user) | Retrieves a user by their identifier. |
| [`openai_admin_update_project_rate_limits`](#openai_admin_update_project_rate_limits) | Updates a project rate limit. |
| [`openai_admin_upload_certificate`](#openai_admin_upload_certificate) | Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates. |
| [`openai_admin_usage_audio_speeches`](#openai_admin_usage_audio_speeches) | Get audio speeches usage details for the organization. |
| [`openai_admin_usage_audio_transcriptions`](#openai_admin_usage_audio_transcriptions) | Get audio transcriptions usage details for the organization. |
| [`openai_admin_usage_code_interpreter_sessions`](#openai_admin_usage_code_interpreter_sessions) | Get code interpreter sessions usage details for the organization. |
| [`openai_admin_usage_completions`](#openai_admin_usage_completions) | Get completions usage details for the organization. |
| [`openai_admin_usage_costs`](#openai_admin_usage_costs) | Get costs details for the organization. |
| [`openai_admin_usage_embeddings`](#openai_admin_usage_embeddings) | Get embeddings usage details for the organization. |
| [`openai_admin_usage_images`](#openai_admin_usage_images) | Get images usage details for the organization. |
| [`openai_admin_usage_moderations`](#openai_admin_usage_moderations) | Get moderations usage details for the organization. |
| [`openai_admin_usage_vector_stores`](#openai_admin_usage_vector_stores) | Get vector stores usage details for the organization. |
***
## openai\_admin\_activate\_organization\_certificates
Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------- |
| `certificate_ids` | string\[] | Yes | — | Certificate Ids |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Certificate Ids"
}
},
"required": [
"PCID",
"certificate_ids"
]
}
```
***
## openai\_admin\_activate\_project\_certificates
Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `certificate_ids` | string\[] | Yes | — | Certificate Ids |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"certificate_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Certificate Ids"
}
},
"required": [
"PCID",
"project_id",
"certificate_ids"
]
}
```
***
## openai\_admin\_archive\_project
Archives a project in the organization. Archived projects cannot be used or updated.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_create\_project
Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------- |
| `name` | string | Yes | — | The friendly name of the project, this name appears in reports. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The friendly name of the project, this name appears in reports."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## openai\_admin\_create\_project\_service\_account
Creates a new service account in the project. This also returns an unredacted API key for the service account.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `name` | string | Yes | — | The name of the service account being created. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"name": {
"type": "string",
"description": "The name of the service account being created."
}
},
"required": [
"PCID",
"project_id",
"name"
]
}
```
***
## openai\_admin\_create\_project\_user
Adds a user to the project. Users must already be members of the organization to be added to a project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `role` | string | Yes | — | `owner` or `member` |
| `user_id` | string | Yes | — | The ID of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"role": {
"type": "string",
"description": "`owner` or `member`",
"enum": [
"owner",
"member"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"project_id",
"role",
"user_id"
]
}
```
***
## openai\_admin\_deactivate\_organization\_certificates
Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------- |
| `certificate_ids` | string\[] | Yes | — | Certificate Ids |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Certificate Ids"
}
},
"required": [
"PCID",
"certificate_ids"
]
}
```
***
## openai\_admin\_deactivate\_project\_certificates
Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `certificate_ids` | string\[] | Yes | — | Certificate Ids |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"certificate_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Certificate Ids"
}
},
"required": [
"PCID",
"project_id",
"certificate_ids"
]
}
```
***
## openai\_admin\_delete\_certificate
Delete a certificate from the organization. The certificate must be inactive for the organization and all projects.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------- |
| `certificate_id` | string | Yes | — | The ID of the certificate. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_id": {
"type": "string",
"description": "The ID of the certificate."
}
},
"required": [
"PCID",
"certificate_id"
]
}
```
***
## openai\_admin\_delete\_invite
Delete an invite. If the invite has already been accepted, it cannot be deleted.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------------- |
| `invite_id` | string | Yes | — | The ID of the invite to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invite_id": {
"type": "string",
"description": "The ID of the invite to delete."
}
},
"required": [
"PCID",
"invite_id"
]
}
```
***
## openai\_admin\_delete\_project\_api\_key
Deletes an API key from the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `key_id` | string | Yes | — | The ID of the API key. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"key_id": {
"type": "string",
"description": "The ID of the API key."
}
},
"required": [
"PCID",
"project_id",
"key_id"
]
}
```
***
## openai\_admin\_delete\_project\_service\_account
Deletes a service account from the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------------ |
| `project_id` | string | Yes | — | The ID of the project. |
| `service_account_id` | string | Yes | — | The ID of the service account. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"service_account_id": {
"type": "string",
"description": "The ID of the service account."
}
},
"required": [
"PCID",
"project_id",
"service_account_id"
]
}
```
***
## openai\_admin\_delete\_project\_user
Deletes a user from the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `user_id` | string | Yes | — | The ID of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"user_id": {
"type": "string",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"project_id",
"user_id"
]
}
```
***
## openai\_admin\_delete\_user
Deletes a user from the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `user_id` | string | Yes | — | The ID of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## openai\_admin\_get\_certificate
Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `certificate_id` | string | Yes | — | Unique ID of the certificate to retrieve. |
| `include` | string\[] | No | — | A list of additional fields to include in the response. Currently the only supported value is `content` to fetch the PEM content of the certificate. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_id": {
"type": "string",
"description": "Unique ID of the certificate to retrieve."
},
"include": {
"type": "array",
"items": {
"type": "string",
"enum": [
"content"
]
},
"description": "A list of additional fields to include in the response. Currently the only supported value is `content` to fetch the PEM content of the certificate."
}
},
"required": [
"PCID",
"certificate_id"
]
}
```
***
## openai\_admin\_invite\_user
Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email` | string | Yes | — | Send an email to this address |
| `projects` | object\[] | No | — | An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior. |
| `role` | string | Yes | — | `owner` or `reader` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "Send an email to this address"
},
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Project's public ID"
},
"role": {
"type": "string",
"enum": [
"member",
"owner"
],
"description": "Project membership role"
}
},
"required": [
"id",
"role"
]
},
"description": "An array of projects to which membership is granted at the same time the org invite is accepted. If omitted, the user will be invited to the default project for compatibility with legacy behavior."
},
"role": {
"type": "string",
"description": "`owner` or `reader`",
"enum": [
"reader",
"owner"
]
}
},
"required": [
"PCID",
"email",
"role"
]
}
```
***
## openai\_admin\_list\_audit\_logs
List user actions and configuration changes within this organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `effective_at` | object | No | — | Return only events whose `effective_at` (Unix seconds) is in this range. |
| `project_ids[]` | string\[] | No | — | Return only events for these projects. |
| `event_types[]` | string\[] | No | — | Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the audit log object. |
| `actor_ids[]` | string\[] | No | — | Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID. |
| `actor_emails[]` | string\[] | No | — | Return only events performed by users with these emails. |
| `resource_ids[]` | string\[] | No | — | Return only events performed on these targets. For example, a project ID updated. |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `before` | string | No | — | A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj\_foo, your subsequent call can include before=obj\_foo in order to fetch the previous page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"effective_at": {
"type": "object",
"description": "Return only events whose `effective_at` (Unix seconds) is in this range.",
"properties": {
"gt": {
"type": "integer",
"description": "Return only events whose `effective_at` (Unix seconds) is greater than this value."
},
"gte": {
"type": "integer",
"description": "Return only events whose `effective_at` (Unix seconds) is greater than or equal to this value."
},
"lt": {
"type": "integer",
"description": "Return only events whose `effective_at` (Unix seconds) is less than this value."
},
"lte": {
"type": "integer",
"description": "Return only events whose `effective_at` (Unix seconds) is less than or equal to this value."
}
}
},
"project_ids[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only events for these projects."
},
"event_types[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"api_key.created",
"api_key.updated",
"api_key.deleted",
"checkpoint_permission.created",
"checkpoint_permission.deleted",
"invite.sent",
"invite.accepted",
"invite.deleted",
"login.succeeded",
"login.failed",
"logout.succeeded",
"logout.failed",
"organization.updated",
"project.created",
"project.updated",
"project.archived",
"service_account.created",
"service_account.updated",
"service_account.deleted",
"rate_limit.updated",
"rate_limit.deleted",
"user.added",
"user.updated",
"user.deleted"
]
},
"description": "Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](/docs/api-reference/audit-logs/object)."
},
"actor_ids[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID."
},
"actor_emails[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only events performed by users with these emails."
},
"resource_ids[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only events performed on these targets. For example, a project ID updated."
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"before": {
"type": "string",
"description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
}
},
"required": [
"PCID"
]
}
```
***
## openai\_admin\_list\_invites
Returns a list of invites in the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
}
},
"required": [
"PCID"
]
}
```
***
## openai\_admin\_list\_organization\_certificates
List uploaded certificates for this organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `order` | string | No | — | Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"order": {
"type": "string",
"description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"PCID"
]
}
```
***
## openai\_admin\_list\_project\_api\_keys
Returns a list of API keys in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_list\_project\_certificates
List certificates for this project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `order` | string | No | — | Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. |
| `project_id` | string | Yes | — | The ID of the project. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"order": {
"type": "string",
"description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.",
"enum": [
"asc",
"desc"
]
},
"project_id": {
"type": "string",
"description": "The ID of the project."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_list\_project\_rate\_limits
Returns the rate limits per model for a project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `project_id` | string | Yes | — | The ID of the project. |
| `limit` | integer | No | — | A limit on the number of objects to be returned. The default is 100. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `before` | string | No | — | A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj\_foo, your subsequent call can include before=obj\_foo in order to fetch the previous page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. The default is 100."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"before": {
"type": "string",
"description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_list\_project\_service\_accounts
Returns a list of service accounts in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_list\_project\_users
Returns a list of users in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_list\_projects
Returns a list of projects.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `include_archived` | boolean | No | — | If `true` returns all projects including those that have been `archived`. Archived projects are not included by default. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"include_archived": {
"type": "boolean",
"description": "If `true` returns all projects including those that have been `archived`. Archived projects are not included by default."
}
},
"required": [
"PCID"
]
}
```
***
## openai\_admin\_list\_users
Lists all of the users in the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | No | — | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| `after` | string | No | — | A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj\_foo, your subsequent call can include after=obj\_foo in order to fetch the next page of the list. |
| `emails` | string\[] | No | — | Filter by the email address of users. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20."
},
"after": {
"type": "string",
"description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by the email address of users."
}
},
"required": [
"PCID"
]
}
```
***
## openai\_admin\_modify\_certificate
Modify a certificate. Note that only the name can be modified.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------------------------ |
| `certificate_id` | string | Yes | — | The ID of the certificate. |
| `name` | string | Yes | — | The updated name for the certificate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"certificate_id": {
"type": "string",
"description": "The ID of the certificate."
},
"name": {
"type": "string",
"description": "The updated name for the certificate"
}
},
"required": [
"PCID",
"certificate_id",
"name"
]
}
```
***
## openai\_admin\_modify\_project
Modifies a project in the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `name` | string | Yes | — | The updated name of the project, this name appears in reports. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"name": {
"type": "string",
"description": "The updated name of the project, this name appears in reports."
}
},
"required": [
"PCID",
"project_id",
"name"
]
}
```
***
## openai\_admin\_modify\_project\_user
Modifies a user's role in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `user_id` | string | Yes | — | The ID of the user. |
| `role` | string | Yes | — | `owner` or `member` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"user_id": {
"type": "string",
"description": "The ID of the user."
},
"role": {
"type": "string",
"description": "`owner` or `member`",
"enum": [
"owner",
"member"
]
}
},
"required": [
"PCID",
"project_id",
"user_id",
"role"
]
}
```
***
## openai\_admin\_modify\_user
Modifies a user's role in the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `user_id` | string | Yes | — | The ID of the user. |
| `role` | string | Yes | — | `owner` or `reader` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "The ID of the user."
},
"role": {
"type": "string",
"description": "`owner` or `reader`",
"enum": [
"owner",
"reader"
]
}
},
"required": [
"PCID",
"user_id",
"role"
]
}
```
***
## openai\_admin\_retrieve\_invite
Retrieves an invite.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | --------------------------------- |
| `invite_id` | string | Yes | — | The ID of the invite to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invite_id": {
"type": "string",
"description": "The ID of the invite to retrieve."
}
},
"required": [
"PCID",
"invite_id"
]
}
```
***
## openai\_admin\_retrieve\_project
Retrieves a project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
}
},
"required": [
"PCID",
"project_id"
]
}
```
***
## openai\_admin\_retrieve\_project\_api\_key
Retrieves an API key in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `key_id` | string | Yes | — | The ID of the API key. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"key_id": {
"type": "string",
"description": "The ID of the API key."
}
},
"required": [
"PCID",
"project_id",
"key_id"
]
}
```
***
## openai\_admin\_retrieve\_project\_service\_account
Retrieves a service account in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------------ |
| `project_id` | string | Yes | — | The ID of the project. |
| `service_account_id` | string | Yes | — | The ID of the service account. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"service_account_id": {
"type": "string",
"description": "The ID of the service account."
}
},
"required": [
"PCID",
"project_id",
"service_account_id"
]
}
```
***
## openai\_admin\_retrieve\_project\_user
Retrieves a user in the project.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `user_id` | string | Yes | — | The ID of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"user_id": {
"type": "string",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"project_id",
"user_id"
]
}
```
***
## openai\_admin\_retrieve\_user
Retrieves a user by their identifier.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `user_id` | string | Yes | — | The ID of the user. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## openai\_admin\_update\_project\_rate\_limits
Updates a project rate limit.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------- |
| `project_id` | string | Yes | — | The ID of the project. |
| `rate_limit_id` | string | Yes | — | The ID of the rate limit. |
| `batch_1_day_max_input_tokens` | integer | No | — | The maximum batch input tokens per day. Only relevant for certain models. |
| `max_audio_megabytes_per_1_minute` | integer | No | — | The maximum audio megabytes per minute. Only relevant for certain models. |
| `max_images_per_1_minute` | integer | No | — | The maximum images per minute. Only relevant for certain models. |
| `max_requests_per_1_day` | integer | No | — | The maximum requests per day. Only relevant for certain models. |
| `max_requests_per_1_minute` | integer | No | — | The maximum requests per minute. |
| `max_tokens_per_1_minute` | integer | No | — | The maximum tokens per minute. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "The ID of the project."
},
"rate_limit_id": {
"type": "string",
"description": "The ID of the rate limit."
},
"batch_1_day_max_input_tokens": {
"type": "integer",
"description": "The maximum batch input tokens per day. Only relevant for certain models."
},
"max_audio_megabytes_per_1_minute": {
"type": "integer",
"description": "The maximum audio megabytes per minute. Only relevant for certain models."
},
"max_images_per_1_minute": {
"type": "integer",
"description": "The maximum images per minute. Only relevant for certain models."
},
"max_requests_per_1_day": {
"type": "integer",
"description": "The maximum requests per day. Only relevant for certain models."
},
"max_requests_per_1_minute": {
"type": "integer",
"description": "The maximum requests per minute."
},
"max_tokens_per_1_minute": {
"type": "integer",
"description": "The maximum tokens per minute."
}
},
"required": [
"PCID",
"project_id",
"rate_limit_id"
]
}
```
***
## openai\_admin\_upload\_certificate
Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| `content` | string | Yes | — | The certificate content in PEM format |
| `name` | string | No | — | An optional name for the certificate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content": {
"type": "string",
"description": "The certificate content in PEM format"
},
"name": {
"type": "string",
"description": "An optional name for the certificate"
}
},
"required": [
"PCID",
"content"
]
}
```
***
## openai\_admin\_usage\_audio\_speeches
Get audio speeches usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_audio\_transcriptions
Get audio transcriptions usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_code\_interpreter\_sessions
Get code interpreter sessions usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_completions
Get completions usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `batch` | boolean | No | — | If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default, return both. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `batch` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"batch": {
"type": "boolean",
"description": "If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default, return both."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model",
"batch"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `batch` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_costs
Get costs details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently only `1d` is supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only costs for these projects. |
| `group_by` | string\[] | No | — | Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them. |
| `limit` | integer | No | — | A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7. |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.",
"enum": [
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only costs for these projects."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"line_item"
]
},
"description": "Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them."
},
"limit": {
"type": "integer",
"description": "A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7."
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_embeddings
Get embeddings usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_images
Get images usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `sources` | string\[] | No | — | Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them. |
| `sizes` | string\[] | No | — | Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `size`, `source` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"sources": {
"type": "array",
"items": {
"type": "string",
"enum": [
"image.generation",
"image.edit",
"image.variation"
]
},
"description": "Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them."
},
"sizes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"256x256",
"512x512",
"1024x1024",
"1792x1792",
"1024x1792"
]
},
"description": "Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them."
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model",
"size",
"source"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `size`, `source` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_moderations
Get moderations usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `user_ids` | string\[] | No | — | Return only usage for these users. |
| `api_key_ids` | string\[] | No | — | Return only usage for these API keys. |
| `models` | string\[] | No | — | Return only usage for these models. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these users."
},
"api_key_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these API keys."
},
"models": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these models."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id",
"user_id",
"api_key_id",
"model"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```
***
## openai\_admin\_usage\_vector\_stores
Get vector stores usage details for the organization.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_time` | integer | Yes | — | Start time (Unix seconds) of the query time range, inclusive. |
| `end_time` | integer | No | — | End time (Unix seconds) of the query time range, exclusive. |
| `bucket_width` | string | No | — | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |
| `project_ids` | string\[] | No | — | Return only usage for these projects. |
| `group_by` | string\[] | No | — | Group the usage data by the specified fields. Support fields include `project_id`. |
| `limit` | integer | No | — | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440 |
| `page` | string | No | — | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start_time": {
"type": "integer",
"description": "Start time (Unix seconds) of the query time range, inclusive."
},
"end_time": {
"type": "integer",
"description": "End time (Unix seconds) of the query time range, exclusive."
},
"bucket_width": {
"type": "string",
"description": "Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`.",
"enum": [
"1m",
"1h",
"1d"
]
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Return only usage for these projects."
},
"group_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project_id"
]
},
"description": "Group the usage data by the specified fields. Support fields include `project_id`."
},
"limit": {
"type": "integer",
"description": "Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440"
},
"page": {
"type": "string",
"description": "A cursor for use in pagination. Corresponding to the `next_page` field from the previous response."
}
},
"required": [
"PCID",
"start_time"
]
}
```