{"info":{"_postman_id":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","name":"Scribeless API documentation","description":"

📄 Getting started

The Scribeless API provides engineers with all the tools necessary to integrate with Scribeless.

To start using the Scribeless API, you need to:

Sign into platform.scribeless.co and setup your team
\n
Create an API key to authenticate requests to the Scribeless API
\n

Authentication

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

You can generate a Scribeless API key for your team in the API keys (Settings > API Keys > Create API Key) section of your Scribeless team settings.

You must include an API key in each request to the Scribeless API with the X-API-Key request header.

\n
⚠️ Warning: Once you confirm you have securely copied an API Key, there is no way of viewing that key again and a new key will need to be created if the secret is lost
\n

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Need some help?

If you have any questions or need additional support, feel free to reach out via email.

Email: team@scribeless.co

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Getting started","slug":"getting-started"}],"owner":"23943032","collectionId":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","publishedId":"2sAYBa8UN2","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"344697","highlight":"344697"},"publishDate":"2024-12-03T10:58:47.000Z"},"item":[{"name":"Recipients","item":[{"name":"Create recipients","id":"c2266f31-012c-46c2-a2eb-3bf925858a34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"campaignId\": \"CAMPAIGN_ID\",\n \"data\": {\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"company\": \"\",\n \"address\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"address3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"variables\": {\n \"custom1\": \"\",\n \"custom2\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.scribeless.co/api/recipients","description":"

The create recipient endpoint allows you to create recipients.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","id":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","name":"Scribeless API documentation","type":"collection"}},"urlObject":{"path":["api","recipients"],"host":["https://platform.scribeless.co"],"query":[],"variable":[]}},"response":[{"id":"0a72f83f-8bb1-4372-8ce2-88c85cd3a320","name":"Create single recipient","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"campaignId\": \"CAMPAIGN_ID\",\n \"data\": {\n \"title\": \"Mr\",\n \"firstName\": \"Joe\",\n \"lastName\": \"Blogs\",\n \"company\": \"Blogs Inc.\",\n \"address\": {\n \"address1\": \"123 Blogs St\",\n \"city\": \"Bristol\",\n \"state\": \"Bristol\",\n \"postalCode\": \"AB123CD\",\n \"country\": \"GB\"\n },\n \"variables\": {\n \"custom1\": \"This is a personalized first sentence\",\n \"custom2\": \"www.scribeless.co\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.scribeless.co/api/recipients"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"ca162f28-92fc-4409-850c-d583bd269261","name":"Create multiple recipients","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"campaignId\": \"CAMPAIGN_ID\",\n \"data\": [\n {\n \"title\": \"Mr\",\n \"firstName\": \"Joe\",\n \"lastName\": \"Blogs\",\n \"company\": \"Blogs Inc.\",\n \"address\": {\n \"address1\": \"123 Blogs St\",\n \"city\": \"Bristol\",\n \"state\": \"Bristol\",\n \"postalCode\": \"AB123CD\",\n \"country\": \"GB\"\n }\n },\n {\n \"title\": \"Mrs\",\n \"firstName\": \"Janet\",\n \"lastName\": \"Blogs\",\n \"company\": \"Blogs Inc.\",\n \"address\": {\n \"address1\": \"123 Blogs St\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"postalCode\": \"12345\",\n \"country\": \"US\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://platform.scribeless.co/api/recipients"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c2266f31-012c-46c2-a2eb-3bf925858a34"}],"id":"99f97be6-83db-4d56-8856-bf5469c3992d","description":"

The recipient endpoints let you manage your recipients in Scribeless.

\n","_postman_id":"99f97be6-83db-4d56-8856-bf5469c3992d","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","id":"22fb5ee4-e24c-4cde-89e6-220a55d68ea9","name":"Scribeless API documentation","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"3073d4b4-6263-4291-81d5-f194b8acff02","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4597f2b3-06ef-40d2-8bf2-75a6cadcdf15","type":"text/javascript","exec":[""]}}],"variable":[{"key":"Base URL","value":"https://platform.scribeless.co"},{"key":"API Key","value":"YOUR_API_KEY_HERE","type":"string"},{"key":"Campaign ID","value":"CAMPAIGN_ID","type":"string"}]}