This article explains how to authenticate requests to the Tekst API.
To authenticate against an endpoint, you need a Tekst API key with sufficient scopes to access the specific endpoint. For detailed information about required scopes for each endpoint, please refer here.
Tekst API keys follow this format:
tkst-Y9S7tCt7EOxxxxx
There are two ways to obtain an API key:
- Inline creation: When setting up an integration, you may automatically receive an API key
- Explicit creation: On the API key overview page, you can create a dedicated API key with specific scopes
To authenticate your request, include your API key in the x-api-key header. The value of this header should be the API key you received.
Example implementation in Postman:
Troubleshooting Common issues
-
401 Error: This indicates you did not include an
x-api-keyheader in your request - 403 Error: This indicates you provided an API key, but it lacks the necessary permissions (insufficient scope, wrong organization, or no access to the requested resource)
Please make sure the base path is https://api.tekst.com
0 comments
Please sign in to leave a comment.