Requests and responses

On this page

  1. URLs and bodies
  2. Unknown and new fields
  3. Pagination
  4. Request IDs

API docs

Get started

Guides

Reference

Endpoints

Reference

Requests and responses

URLs and bodies

The base URL is https://www.inkly.so/api/v1. Bodies are JSON, sent with Content-Type: application/json, and can be up to 64 KB.

Unknown and new fields

Unknown fields in a request body or list query are refused with unknown_field, so a typo cannot pass silently. Responses can gain new fields without notice, so ignore the ones you do not recognize.

Pagination

Lists return newest first. When next_cursor is not null, pass it as cursor to get the next page. limit is 1 to 100, and defaults to 25.

curl "https://www.inkly.so/api/v1/documents?limit=100" \
  -H "Authorization: Bearer $INKLY_API_KEY"

# While next_cursor is not null, pass it back as cursor:
curl "https://www.inkly.so/api/v1/documents?limit=100&cursor=NEXT_CURSOR" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Request IDs

Every response from the API carries an Inkly-Request-Id header. Include it if you contact support.