API

This article explains the API settings section available on the Tekst platform.

Navigating

To access the API settings page, navigate to the following URL:

https://{customer}.tekst.com/settings/apikeys

You can also reach this page from the dashboard by following: Settings > API Keys

Managing API keys

The API settings section allows you to:

1. View all existing API keys
2. Revoke API keys when necessary
3. Examine the groups, resources, and scopes associated with each key

Adding API keys

There are two methods for creating new API keys:

1. Inline creation: Keys can be generated automatically when setting up integrations or in other contexts where API access is required
2. Explicit creation: Keys can be created directly through the API key settings tab

When explicitly creating an API key, you must provide a name and specify the appropriate scopes. For security best practices, we recommend avoiding overly broad scopes.

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-key header 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

This article provides an overview and access information for resources linked to the S3 API.

Available S3 APIs

There are two main APIs available for S3 integration:

• Upload API: Used to upload files and trigger new file processing
• Feedback API: Used to provide feedback for model improvement

For detailed information about S3 integration APIs, please refer to the articles specific to S3 integration, which include comprehensive API documentation.

For access to other APIs not covered in this documentation, please contact your Tekst representative. They will provide you with the necessary API details and Swagger documentation to meet your specific needs.