Sending

Start a PDF upload

post/uploads

Reserves a one-hour upload for a PDF of up to 20 MB and 500 pages. Then send the file with PUT to upload_url, setting Content-Type: application/pdf and no API key, and pass upload_id to POST /documents/from-upload.

Needs a key with documents:send.

Request body

file_namestringRequired
Must end in .pdf.
byte_sizenumberRequired
The exact size of the file you will upload, in bytes.

Example request

curl -X POST "https://www.inkly.so/api/v1/uploads" \
  -H "Authorization: Bearer $INKLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file_name": "consulting-agreement.pdf",
    "byte_size": 482133
  }'

Example response, 201

{
  "upload_id": "d06b8e24-9f13-4c7a-a5d8-3e1c7f2b6049",
  "upload_url": "https://files.example.com/upload/consulting-agreement.pdf?token=example",
  "expires_at": "2026-11-02T16:04:05.123Z"
}

Response fields

upload_idUUIDRequired
upload_urlURLRequired
PUT the PDF here. The URL is its own credential, so send no API key.
expires_attimestampRequired
One hour after the upload was created.

Errors specific to this endpoint

invalid_request400The request is invalid.
unknown_field400This field is not supported.
body_too_large413The JSON body must be at most 64 KB.
temporarily_unavailable503The service is temporarily unavailable. Try again.

Every endpoint can also return the common errors.