Skip to main content
GET
List files
List files for your project. Filter with purpose=batch (uploads) or purpose=batch_output (batch results; check is_error on each item for error files). Use last_id from the response as after on the next request to page. Full reference: Files API.

Authorizations

x-api-key
string
header
required

Headers

x-project-id
string

Optional project identifier. Scopes the request to a specific project when provided.

Query Parameters

purpose
enum<string>

Filter by purpose. batch_output includes success and error output files (is_error on each object).

Available options:
batch,
batch_output
order
enum<string>
default:desc
Available options:
desc,
asc
after
string

Cursor: file id from the previous page (or last_id from the prior response).

limit
integer
default:10000
Required range: 1 <= x <= 10000

Response

File list

object
enum<string>
Available options:
list
data
object[]
first_id
string | null
last_id
string | null
has_more
boolean