OpenAI API

AuditLogActorUser

object

The user who performed the audit logged action.

idstring

The user id.

emailstring

The user email.

Example

AuditLogEventType

string

The event type.

Allowed values:api_key.createdapi_key.updatedapi_key.deletedinvite.sentinvite.acceptedinvite.deletedlogin.succeededlogin.failedlogout.succeededlogout.failedorganization.updatedproject.createdproject.updatedproject.archivedservice_account.createdservice_account.updatedservice_account.deletedrate_limit.updatedrate_limit.deleteduser.addeduser.updateduser.deleted

Auto Chunking Strategy

object

The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400.

* Additional properties are NOT allowed.
typestringrequired

Always auto.

Allowed values:auto

Example

Batch

object
idstringrequired
objectstringrequired

The object type, which is always batch.

Allowed values:batch

endpointstringrequired

The OpenAI API endpoint used by the batch.

errorsobject
Show Child Parameters
input_file_idstringrequired

The ID of the input file for the batch.

completion_windowstringrequired

The time frame within which the batch should be processed.

statusstringrequired

The current status of the batch.

Allowed values:validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled

output_file_idstring

The ID of the file containing the outputs of successfully executed requests.

error_file_idstring

The ID of the file containing the outputs of requests with errors.

created_atintegerrequired

The Unix timestamp (in seconds) for when the batch was created.

in_progress_atinteger

The Unix timestamp (in seconds) for when the batch started processing.

expires_atinteger

The Unix timestamp (in seconds) for when the batch will expire.

finalizing_atinteger

The Unix timestamp (in seconds) for when the batch started finalizing.

completed_atinteger

The Unix timestamp (in seconds) for when the batch was completed.

failed_atinteger

The Unix timestamp (in seconds) for when the batch failed.

expired_atinteger

The Unix timestamp (in seconds) for when the batch expired.

cancelling_atinteger

The Unix timestamp (in seconds) for when the batch started cancelling.

cancelled_atinteger

The Unix timestamp (in seconds) for when the batch was cancelled.

request_countsobject

The request counts for different statuses within the batch.

Show Child Parameters
metadataobject

Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.

Example

BatchRequestInput

object

The per-line object of the batch input file

custom_idstring

A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch.

methodstring

The HTTP method to be used for the request. Currently only POST is supported.

Allowed values:POST

urlstring

The OpenAI API relative URL to be used for the request. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported.

Example