Authentication

The platform API uses the X-API-Key header for authentication.

Generate an API key in Scribeless API key settings, then include it with every request.

Create an API key

1. Open Settings > API keys.
2. Select Create API Key.
3. Copy the key immediately. Scribeless only shows the secret once.
4. Store it in your server-side secrets manager or automation platform credential store.

X-API-Key: YOUR_API_KEY

API key handling

• Keep API keys server-side. Do not expose them in browsers, mobile apps, public repositories, or client-side JavaScript.
• Use environment variables or a secrets manager, for example SCRIBELESS_API_KEY.
• Rotate the key if it may have been exposed.
• If the secret is lost, create a new key.

Example

curl --request POST 'https://platform.scribeless.co/api/recipients' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --data '{
    "campaignId": "CAMPAIGN_ID",
    "data": {
      "firstName": "Ada",
      "lastName": "Lovelace",
      "address": {
        "address1": "1 Example Street",
        "city": "London",
        "state": "London",
        "postalCode": "SW1A 1AA",
        "country": "GB"
      }
    }
  }'

Errors

If an API key is missing, malformed, or invalid, Scribeless returns an authentication error.

{
  "error": true,
  "url": "https://platform.scribeless.co/api/templates",
  "statusCode": 401,
  "statusMessage": "Server Error",
  "message": "Invalid authentication token."
}

If Scribeless returns 503, API traffic may be temporarily elevated. The service is usually operational within five minutes. If the outage persists, or you receive another 5xx error, contact team@scribeless.co.