Blueprints / Actions

Start an upload: get a signed URL

Step 1 of the two-step upload: request a pre-signed URL for a blueprint.

Upload the file with an HTTP PUT to the returned signed_url, sending exactly the headers in required_headers, then call /upload/complete with the returned file_uuid. Recommended for large files.

post/v1/blueprints/upload/init

Request

  • Base URL: https://api.kamai.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.kamai.io/v1/blueprints/upload/init
  • Auth: HTTP bearer

Request body

project_idstring nullable

Target project ID. When omitted, the user's Default Project is used or created.

filenamestring nullable

Desired filename. When omitted, a UTC-timestamped default is used. Sanitized server-side.

mime_typestring nullable

File MIME type. Defaults to application/pdf; only application/pdf is allowed for now.

Response

Successful Response

file_uuidstring required

Identifier for this pending upload; pass it to /upload/complete.

user_idstring required

Authenticated user ID.

project_idstring required

Resolved project ID.

signed_urlstring required

Pre-signed URL. Upload the file here with an HTTP PUT.

methodstring

HTTP method to use against signed_url.

expires_ininteger required

Seconds until the signed URL expires.

required_headersobject required

Exact headers the client MUST send on the PUT (the signature enforces them).

Changes

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