Uploads

Files sent ahead of a save, for note images, photos and documents.

On this page

Upload a file

Upload a file

POST/uploads

Upload an image for a note body or a person's photo, or a PDF for a task.

The body is the file itself, with a Content-Length (without one it's 411 length_required): an image up to 20 MB, or a PDF up to 50 MB (more is 413 payload_too_large, before the body is read). The type is read from the bytes and must be the kind sent; the Content-Type must still be one of the types below (anything else is 415). Embed an image in body_html by its signed_id (see "Note bodies"), or set it as a person's avatar (10 MB at most); send a PDF's in a task's document_uploads. An upload not used within 7 days is deleted.

curl -X POST "$NIFTY_URL/api/v1/uploads" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '"@file.pdf"'

Query parameters

Name	Description
`filename`string · optional	1–255 characters. Defaults to `image.<extension>`, or `document.pdf`.

Headers

Name	Description
`Idempotency-Key`string · optional	Makes a POST safe to retry for 24 hours. Needs a bearer token (`400` under session auth).

Response

201 Created Errors: 400 401 403 409 411 413 415 422 429

{
  "data": {
    "signed_id": "string",
    "url": "https://example.com",
    "filename": "boiler-warranty.pdf",
    "content_type": "image/jpeg",
    "byte_size": 1,
    "width": 1,
    "height": 1
  }
}