Upload Remote File

Fetch a remote URL and attach the resulting file to a paused Human Input form.

POST /form/human_input/files/remote-upload

Error

A valid request URL is required to generate request examples

201

uploadSuccess

{
  "id": "1a77f0df-c0e6-461c-987c-e72526f341ee",
  "name": "report.pdf",
  "size": 204800,
  "extension": "pdf",
  "url": "https://files.example.com/signed/report.pdf?sig=abc123",
  "mime_type": "application/pdf",
  "created_by": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
  "created_at": 1705407629
}

Authorizations

Authorization · string · header · required

Short-lived upload token for attaching files to a Human Input form. Obtain via Issue Upload Token and pass as Authorization: Bearer hitl_upload_{token}.

Body

application/json

url · string<uri> · required

Publicly reachable URL of the file to fetch and attach.

Response

201

application/json

File fetched and attached successfully.

id · string

Reference this value as upload_file_id in file and file-list inputs on Submit Human Input Form.

name · string

File name derived from the remote URL or response headers.

size · integer

File size in bytes.

extension · string | null

File extension.

url · string | null

Signed URL for fetching the file's contents.

mime_type · string | null

MIME type of the file.

created_by · string | null

Identifier of the user the file was uploaded for.

created_at · integer<int64> | null

Unix timestamp (seconds) when the file was created.