Assistants
- GETList assistants
- POSTCreate assistant
- GETRetrieve assistant
- POSTModify assistant
- DELDelete assistant
- POSTCreate thread
- POSTCreate thread and run
- GETRetrieve thread.
- POSTModify thread
- DELDelete thread
- GETList messages
- POSTCreate message
- GETRetrieve message
- POSTModify message
- DELDelete message
- GETList runs
- POSTCreate run
- GETRetrieve run
- POSTModify run
- POSTCancel run
- GETList run steps
- GETRetrieve run step
- POSTThe run step object
Chat
Completions
Embeddings
Evals
Files
Fine-tuning
- GETList checkpoint permissions
- POSTCreate checkpoint permissions
- DELDelete checkpoint permission
- GETList your organization's fine-tuning jobs
- POSTCreate a fine-tuning job
- GETRetrieve fine-tuning job
- POSTImmediately cancel a fine-tune job.
- GETList checkpoints for a fine-tuning job.
- GETGet status updates for a fine-tuning job.
Moderations
API Reference
Audit Logs
Certificates
Usage
Projects
- GETReturns a list of projects.
- POSTCreate project
- GETRetrieves a project.
- POSTModify project
- GETList project API keys
- GETRetrieve project API key
- DELDelete project API key
- POSTArchive project
- GETList project rate limits
- POSTUpdate project rate limit
- GETList project service accounts
- POSTCreate project service account
- GETRetrieve project service account
- DELDelete project service account
- GETReturn project users
- POSTCreate project user
- GETRetrieve project user
- POSTModify project user
- DELDelete project user
Responses
Vector stores
- GETReturns a list of vector stores.
- POSTCreate a vector store.
- GETRetrieves a vector store.
- POSTModifies a vector store.
- DELDelete a vector store.
- POSTCreate a vector store file batch.
- GETRetrieves a vector store file batch.
- POSTCancel vector store file batch
- GETReturns a list of vector store files in a batch.
- GETReturns a list of vector store files.
- POSTCreate vector store file
- GETRetrieves a vector store file.
- POSTUpdate attributes on a vector store file.
- DELDelete vector store file
- GETRetrieve vector store
- POSTSearch vector store
List audit logs
List user actions and configuration changes within this organization.
curl --request GET \
--url https://api.openai.com/v1/organization/audit_logs \
--header 'Authorization: Bearer <token>'
{
"object": "list",
"data": [
{
"id": "<string>",
"type": "api_key.created",
"effective_at": 123,
"project": {
"id": "<string>",
"name": "<string>"
},
"actor": {
"type": "session",
"session": {
"user": {
"id": "<string>",
"email": "<string>"
},
"ip_address": "<string>"
},
"api_key": {
"id": "<string>",
"type": "user",
"user": {
"id": "<string>",
"email": "<string>"
},
"service_account": {
"id": "<string>"
}
}
},
"api_key.created": {
"id": "<string>",
"data": {
"scopes": [
"<string>"
]
}
},
"api_key.updated": {
"id": "<string>",
"changes_requested": {
"scopes": [
"<string>"
]
}
},
"api_key.deleted": {
"id": "<string>"
},
"checkpoint_permission.created": {
"id": "<string>",
"data": {
"project_id": "<string>",
"fine_tuned_model_checkpoint": "<string>"
}
},
"checkpoint_permission.deleted": {
"id": "<string>"
},
"invite.sent": {
"id": "<string>",
"data": {
"email": "<string>",
"role": "<string>"
}
},
"invite.accepted": {
"id": "<string>"
},
"invite.deleted": {
"id": "<string>"
},
"login.failed": {
"error_code": "<string>",
"error_message": "<string>"
},
"logout.failed": {
"error_code": "<string>",
"error_message": "<string>"
},
"organization.updated": {
"id": "<string>",
"changes_requested": {
"title": "<string>",
"description": "<string>",
"name": "<string>",
"settings": {
"threads_ui_visibility": "<string>",
"usage_dashboard_visibility": "<string>"
}
}
},
"project.created": {
"id": "<string>",
"data": {
"name": "<string>",
"title": "<string>"
}
},
"project.updated": {
"id": "<string>",
"changes_requested": {
"title": "<string>"
}
},
"project.archived": {
"id": "<string>"
},
"rate_limit.updated": {
"id": "<string>",
"changes_requested": {
"max_requests_per_1_minute": 123,
"max_tokens_per_1_minute": 123,
"max_images_per_1_minute": 123,
"max_audio_megabytes_per_1_minute": 123,
"max_requests_per_1_day": 123,
"batch_1_day_max_input_tokens": 123
}
},
"rate_limit.deleted": {
"id": "<string>"
},
"service_account.created": {
"id": "<string>",
"data": {
"role": "<string>"
}
},
"service_account.updated": {
"id": "<string>",
"changes_requested": {
"role": "<string>"
}
},
"service_account.deleted": {
"id": "<string>"
},
"user.added": {
"id": "<string>",
"data": {
"role": "<string>"
}
},
"user.updated": {
"id": "<string>",
"changes_requested": {
"role": "<string>"
}
},
"user.deleted": {
"id": "<string>"
},
"certificate.created": {
"id": "<string>",
"name": "<string>"
},
"certificate.updated": {
"id": "<string>",
"name": "<string>"
},
"certificate.deleted": {
"id": "<string>",
"name": "<string>",
"certificate": "<string>"
},
"certificates.activated": {
"certificates": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"certificates.deactivated": {
"certificates": [
{
"id": "<string>",
"name": "<string>"
}
]
}
}
],
"first_id": "audit_log-defb456h8dks",
"last_id": "audit_log-hnbkd8s93s",
"has_more": true
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Return only events whose effective_at
(Unix seconds) is in this range.
Return only events for these projects.
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.
Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.
Return only events performed by users with these emails.
Return only events performed on these targets. For example, a project ID updated.
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
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.
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.
Response
Audit logs listed successfully.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.openai.com/v1/organization/audit_logs \
--header 'Authorization: Bearer <token>'
{
"object": "list",
"data": [
{
"id": "<string>",
"type": "api_key.created",
"effective_at": 123,
"project": {
"id": "<string>",
"name": "<string>"
},
"actor": {
"type": "session",
"session": {
"user": {
"id": "<string>",
"email": "<string>"
},
"ip_address": "<string>"
},
"api_key": {
"id": "<string>",
"type": "user",
"user": {
"id": "<string>",
"email": "<string>"
},
"service_account": {
"id": "<string>"
}
}
},
"api_key.created": {
"id": "<string>",
"data": {
"scopes": [
"<string>"
]
}
},
"api_key.updated": {
"id": "<string>",
"changes_requested": {
"scopes": [
"<string>"
]
}
},
"api_key.deleted": {
"id": "<string>"
},
"checkpoint_permission.created": {
"id": "<string>",
"data": {
"project_id": "<string>",
"fine_tuned_model_checkpoint": "<string>"
}
},
"checkpoint_permission.deleted": {
"id": "<string>"
},
"invite.sent": {
"id": "<string>",
"data": {
"email": "<string>",
"role": "<string>"
}
},
"invite.accepted": {
"id": "<string>"
},
"invite.deleted": {
"id": "<string>"
},
"login.failed": {
"error_code": "<string>",
"error_message": "<string>"
},
"logout.failed": {
"error_code": "<string>",
"error_message": "<string>"
},
"organization.updated": {
"id": "<string>",
"changes_requested": {
"title": "<string>",
"description": "<string>",
"name": "<string>",
"settings": {
"threads_ui_visibility": "<string>",
"usage_dashboard_visibility": "<string>"
}
}
},
"project.created": {
"id": "<string>",
"data": {
"name": "<string>",
"title": "<string>"
}
},
"project.updated": {
"id": "<string>",
"changes_requested": {
"title": "<string>"
}
},
"project.archived": {
"id": "<string>"
},
"rate_limit.updated": {
"id": "<string>",
"changes_requested": {
"max_requests_per_1_minute": 123,
"max_tokens_per_1_minute": 123,
"max_images_per_1_minute": 123,
"max_audio_megabytes_per_1_minute": 123,
"max_requests_per_1_day": 123,
"batch_1_day_max_input_tokens": 123
}
},
"rate_limit.deleted": {
"id": "<string>"
},
"service_account.created": {
"id": "<string>",
"data": {
"role": "<string>"
}
},
"service_account.updated": {
"id": "<string>",
"changes_requested": {
"role": "<string>"
}
},
"service_account.deleted": {
"id": "<string>"
},
"user.added": {
"id": "<string>",
"data": {
"role": "<string>"
}
},
"user.updated": {
"id": "<string>",
"changes_requested": {
"role": "<string>"
}
},
"user.deleted": {
"id": "<string>"
},
"certificate.created": {
"id": "<string>",
"name": "<string>"
},
"certificate.updated": {
"id": "<string>",
"name": "<string>"
},
"certificate.deleted": {
"id": "<string>",
"name": "<string>",
"certificate": "<string>"
},
"certificates.activated": {
"certificates": [
{
"id": "<string>",
"name": "<string>"
}
]
},
"certificates.deactivated": {
"certificates": [
{
"id": "<string>",
"name": "<string>"
}
]
}
}
],
"first_id": "audit_log-defb456h8dks",
"last_id": "audit_log-hnbkd8s93s",
"has_more": true
}