OpenAI API

OpenAIFile

The File object represents a document that has been uploaded to OpenAI.

idstringrequired

The file identifier, which can be referenced in the API endpoints.

bytesintegerrequired

The size of the file, in bytes.

created_atintegerrequired

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

filenamestringrequired

The name of the file.

objectstringrequired

The object type, which is always file.

Allowed values:file

purposestringrequired

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

Allowed values:assistantsassistants_outputbatchbatch_outputfine-tunefine-tune-resultsvision

statusstringrequiredDEPRECATED

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

Allowed values:uploadedprocessederror

status_detailsstringDEPRECATED

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Example

Other Chunking Strategy

object

This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API.

* Additional properties are NOT allowed.
typestringrequired

Always other.

Allowed values:other

Example

ParallelToolCalls

boolean

Whether to enable parallel function calling during tool use.

Default:true

Static Content

object

Static predicted output content, such as the content of a text file that is
being regenerated.

typestringrequired

The type of the predicted content you want to provide. This type is
currently always content.

Allowed values:content

contentOne Of
required

The content that should be matched when generating a model response.
If generated tokens would match this content, the entire model response
can be returned much more quickly.

Text contentstring

The content used for a Predicted Output. This is often the
text of a file you are regenerating with minor changes.

Example

Project

object

Represents an individual project.

idstringrequired

The identifier, which can be referenced in API endpoints

objectstringrequired

The object type, which is always organization.project

Allowed values:organization.project

namestringrequired

The name of the project. This appears in reporting.

created_atintegerrequired

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

archived_atinteger

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

statusstringrequired

active or archived

Allowed values:activearchived

Example