API Reference
Files and Uploads
Manage persistent account Files, multipart Uploads, and Moderation Batches through OpenAI-compatible endpoints.
- Persistent Files Create and manage immutable Account-scoped user_data, batch, and batch_output Files through the OpenAI-compatible Files API.
- File object An immutable persistent File identified by a RunAPI File ID without storage implementation details.
- Create a File Stream one multipart user_data or batch File into persistent storage.
- List Files List active Files in deterministic cursor order.
- Retrieve a File Retrieve active File metadata by ID.
- Retrieve File content Stream the exact stored File bytes.
- Delete a File Logically delete a File and schedule its stored content for cleanup.
- Uploads Reserve, assemble, complete, or cancel a persistent File Upload from ordered Parts.
- Upload object A one-hour multipart Upload reservation and its terminal File when completed.
- Create an Upload Reserve the declared final File bytes for one Upload.
- Add an Upload Part Stream one multipart Part into an unfinished Upload.
- Complete an Upload Compose Parts in the supplied order and create one immutable File.
- Cancel an Upload Cancel a pending Upload idempotently.
- Batches Submit and observe OpenAI-compatible Moderation Batch work using a purpose=batch File.
- Batch object An Account-scoped Moderation Batch whose execution lifecycle is reported by the compatible Batch API.
- List Batches List Batches created by the current Account.
- Create a Batch Submit a Moderation Batch backed by a valid purpose=batch File.
- Retrieve a Batch Retrieve the current Batch status and request counts.
- Cancel a Batch Ask the execution provider to cancel a non-terminal Batch.