Skip to content

Popular

  • QuickstartDevelopers
  • AuthenticationBasics
  • WebhooksBasics
  • Upload a documentPOST /v1/read/documents
  • Get a document’s fieldsGET /v1/read/documents/{id}/fields
  • Extract your own fieldsREAD · Document Extraction
Overview menu

Basics

Authentication

Create API keys, choose their scope and send them with every request.

Every request to the Rowland API is authenticated with an API key, sent in the x-api-key header:

bash
curl "https://api.rowland.ai/v1/read/documents" \
  -H "x-api-key: $ROWLAND_API_KEY"

A request without a key, or with a key that is wrong, inactive or expired, gets 401 Unauthorized.

Get a key

API access is by arrangement. Talk to us and the Rowland team issues your keys, with:

  • A name that says where the key is used, such as "Production sync".
  • A scope: Personal or Organization (see below).
  • An expiry date, if you want one.

The full key is shown once. Store it in a secrets manager or an environment variable; Rowland keeps only a fingerprint of it and cannot show it again. Organization admins can see and revoke their keys in the Rowland app, under Settings → API Keys.

Scopes

Both kinds of key work with your organization's documents, extractions and missions.

Scope Acts as
Personal One person. Work done with it is theirs.
Organization The organization. Work is attributed to the person the key was issued to.

A key never reaches another organization's data. Asking for anything your key cannot see returns 404, the same as one that does not exist.

Keep keys safe

  • Never put a key in client-side code or commit it to version control.
  • Use one key per system and environment, so you can rotate or revoke one without touching the others.
  • Set an expiry that matches your rotation policy.
  • Rotate by asking for a new key, deploying it, then revoking the old one.
  • Revoke a key at once if you think it has leaked. Rowland may also disable a key that has been published.