Skip to main content
POST
Copy one external image into Batch Relay-managed fulfillment storage

Authorizations

Authorization
string
header
required

Batch Relay scoped API key, not OAuth. Scope names document required key capabilities.

Headers

Idempotency-Key
string
required

Required stable key for the managed ingestion request; reuse with a different URL/source is rejected.

Required string length: 1 - 200

Body

application/json
url
string<uri>
required

One external source. It is downloaded and never retained as the fulfillment URL.

Pattern: ^https://
asset_id
string

One already-finalized Batch Relay or platform image asset. It is resolved and reused without a byte copy.

original_filename
string
Maximum string length: 255

Response

Managed immutable asset

asset_id
string
required

Opaque identifier for later managed-asset attachment.

storage_scope
enum<string>
required

External URL ingress always returns fulfillment; private delivery uses this scope plus object-key lookup.

Available options:
studio,
fulfillment
byte_size
integer
required
Required range: x >= 1
content_type
enum<string>
required
Available options:
image/jpeg,
image/png,
image/tiff
format
enum<string>
required
Available options:
jpeg,
png,
tiff
pixel_width
integer
required
Required range: x >= 1
pixel_height
integer
required
Required range: x >= 1
sha256
string
required
Pattern: ^[a-f0-9]{64}$
original_filename
string
required
reused
boolean
required

True when the same immutable object already existed or a finalized asset_id was reused.