OpenAI API

UserDeleteResponse

object
objectstringrequired

Allowed values:organization.user.deleted

idstringrequired
deletedbooleanrequired
Example

UserListResponse

object
objectstringrequired

Allowed values:list

dataarray[object]required

Represents an individual user within an organization.

Show Child Parameters
first_idstringrequired
last_idstringrequired
has_morebooleanrequired
Example

UserRoleUpdateRequest

object
rolestringrequired

owner or reader

Allowed values:ownerreader

Example

Vector store expiration policy

object

The expiration policy for a vector store.

anchorstringrequired

Anchor timestamp after which the expiration policy applies. Supported anchors: last_active_at.

Allowed values:last_active_at

daysintegerrequired

The number of days after the anchor time that the vector store will expire.

>= 1<= 365

Example

Vector store file batch

object

A batch of files attached to a vector store.

idstringrequired

The identifier, which can be referenced in API endpoints.

objectstringrequired

The object type, which is always vector_store.file_batch.

Allowed values:vector_store.files_batch

created_atintegerrequired

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

vector_store_idstringrequired

The ID of the vector store that the File is attached to.

statusstringrequired

The status of the vector store files batch, which can be either in_progress, completed, cancelled or failed.

Allowed values:in_progresscompletedcancelledfailed

file_countsobjectrequired
Show Child Parameters
Example