Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceInferenceFiles

Get a file's metadata

Returns a file's metadata (id, size in bytes, purpose, and creation and expiry times) for a batch input or result file, without its content. The filename is assigned by the server, not the name you uploaded.

Required permission

Requires the batch.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl files get <id>
GET
/v1/files/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

id*string

Response Body

OK

application/json
  1. response

A file stored for the Batch API (OpenAI-compatible).

id*string

File id (file-…). Pass it as input_file_id when creating a batch.

object*"file"
Value in"file"
bytes*integer

File size in bytes.

Formatint64
created_at*integer

Unix timestamp (seconds).

Formatint64
expires_at?integer

Unix timestamp (seconds); files are retained for 30 days.

Formatint64
filename*string
purpose*string

"batch" for inputs, "batch_output" / "batch_error" for result files.

Example Request
curl -X GET 'https://inference.openrelay.inc/v1/files/string'
Example Response
{  "id": "string",  "object": "file",  "bytes": 0,  "created_at": 0,  "expires_at": 0,  "filename": "string",  "purpose": "string"}

Register a file after its presigned upload POST

Validates an object uploaded to a presigned URL (size, line count) and registers it as a batch input file, returning the file object to use in a batch. Idempotent; completing an already-registered id returns the existing file.

Download a file's raw JSONL content GET

Streams a file's raw bytes as application/octet-stream, for a batch input file you uploaded or a result file that a batch has written. Use it to fetch batch results: the batch object's output_file_id (successful records) and error_file_id (failed records) each point at a JSONL file of `{custom_id, response | error}` lines.