Guides

Ingest from URI

Use of this API to request FileSpin to retrieve a file from external HTTP URL or a S3 Bucket and create an asset.

Note

  • If S3 source is provided, the S3 Bucket must have S3 Access policy to authorize FileSpin access (see Asset Storage section for policy details)
  • If HTTP URL is provided, the URL must supply downloadable content and should not require authentication. Downloads from external websites will be rate-limited.
  • Adding custom metadata as part of this request is not supported at this time

Example request JSON payload

Request to pull a S3 file

{
  "name": "test.jpg",
  "key": "s3://my-bucket/test.jpg"
}

Request to pull a file from a https URL

{
  "name": "test.jpg",
  "key": "https://example.com/test.jpg"
}

HTTP RESPONSE

Standard HTTP Status code (202 or 200).

KeyValueDescription
idstringAsset ID, 32 character alphanumeric UUID
statusstring"QUEUED" if request was successfully received, "ERROR" if request cannot be processed
messagestringAdditional details about status

Response JSON

{
  "id": "ceace459cd2a4d2c904e38e9ab352ebb",
  "status": "QUEUED",
  "message": "Queued for processing"
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!