Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferencePricingDashboard
Files

Get a file's metadata

GET
/v1/files/{id}

Authorization

apiKey
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/files/string"
{
  "id": "string",
  "object": "file",
  "bytes": 0,
  "created_at": 0,
  "expires_at": 0,
  "filename": "string",
  "purpose": "string"
}
{
  "error": {
    "message": "string",
    "type": "string",
    "code": "string"
  }
}
{
  "error": {
    "message": "string",
    "type": "string",
    "code": "string"
  }
}

Command line

The orl CLI wraps this endpoint:

orl files get <id>

Register a presigned upload after the PUT succeeds POST

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

Download a file's raw JSONL content GET

Streams the file bytes. 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.