Images

Create a pre-signed S3 POST upload signature for an image

Advanced path for large images: upload the bytes directly to S3, then call createImage with s3_key=<key>. Agents without S3 egress should instead use createImage with url (server fetches) or, for small images, file_base64. POST to post_url as multipart/form-data with the returned fields and the binary file field LAST. Requires the images feature.

post/api/v1/images/upload_signatures

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/images/upload_signatures
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: images:write)

Request body

filenamestring required
content_type'image/jpeg' | 'image/png' | 'image/webp' required

Response

Pre-signed POST credentials

datestring

Send as form field X-Amz-Date

policystring

Send as form field Policy

signaturestring

Send as form field X-Amz-Signature

keystring

S3 object key; send as form field key and reuse as s3_key

algorithmstring

Send as form field X-Amz-Algorithm

credentialstring

Send as form field X-Amz-Credential

aclstring

Send as form field acl

post_urlstring

URL to POST the multipart/form-data upload to

Changes

No recorded changes to this operation across all 1 revision of this API.