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

Register a presigned upload after the PUT succeeds

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.

POST
/v1/files/{id}/complete

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

application/json

curl -X POST "https://example.com/v1/files/string/complete"
{
  "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"
  }
}
{
  "error": {
    "message": "string",
    "type": "string",
    "code": "string"
  }
}

Mint a signed URL for a direct JSONL upload POST

For browser clients that upload the file straight to storage instead of through the API: returns a file id and a signed PUT URL (valid 15 minutes). After the PUT succeeds, register the file with the complete call. CLI and SDK clients should use the plain upload instead.

Get a file's metadata GET

Next Page