API Authentication
Scopes
Scopes allow for allowing and restricting access to API endpoints.
When creating either type of API credential you can specify which scopes the API credentials are allowed to access. This allows you to setup credentials that only have access to certain endpoints for scenarios where you would like to restrict usage.
| Scope | Required By Endpoints | Purpose |
|---|---|---|
| client.balance | /v1/client/balance | Read the latest credit balance. |
| document.expense | /v1/document/expenses | Read the receipt or invoice data from an image or document, use when source images or documents are receipts or invoices. |
| document.text | /v1/document/text/v1/document/text/summarize | Read the text from an image or document, use when source image or document is any sort of image or document that has text in it. |
| document.identity | /v1/document/identity | Read the identity information from an image or document, use source image or document is either identity documents, drivers licenses or passports. |
| image.calories | /v1/image/calories | Extract the list of food and drink and their calorie counts and macros from an image. |
| image.list | /v1/image/list | Extract the list of items from an image. |
| language.detect | /v1/language/detect | Detect the language(s) used in a body of text. |
| language.translate | /v1/language/translate | Translate a body of text from one language to another language. |
| pii.detect | /v1/pii/detect | Detect and return the location and probability of words being classified as personally identifiable information (PII) within a body of text. |
| pii.redact | /v1/pii/redact | Detect and redact words classified as personally identifiable information (PII) within a body of text. |
| scraper.markdown | /v1/scraper/markdown/v1/scraper/summarize | Extract and converts the contents of a web page to markdown. |
| speech.transcribe | /v1/speech/transcribe/v1/speech/todo/v1/speech/calories/v1/speech/expenses | Transcribe an audio file and return the text. |
| text.calories | /v1/text/calories/v1/speech/calories | Extract the list of food and drink and their calorie counts and macros from the text supplied. |
| text.classify | /v1/text/classify/v1/text/classify/multiple | Classify the text passed in based on the list of classifications. |
| text.expenses | /v1/text/expenses/v1/speech/expenses | Extract the list of expenses, amounts and classifications from a body of text. |
| text.sentiment | /v1/text/sentiment | Detect the overall sentiment of a body of text. |
| text.summarize | /v1/text/summarize/v1/document/text/summarize/v1/scraper/summarize | Summarize a body of text into an array of points. |
| text.todos | /v1/text/todo/v1/speech/todo | Workout a todo and possible reminder from a body of text. |