Overview

Ejento AI offers REST APIs that let developers work with assistants, projects, corpora, and more from their own applications. API keys let those applications call the APIs securely. Each key proves who is calling and limits what the caller is allowed to do.

Why API keys matter

Authentication. Every request identifies your organization, so only trusted applications can call the APIs.

Authorization. Each key has a permission scope, so an integration can do only what it needs.

Control. You can see who created each key and when, change its permissions, or revoke it at any time.

Visibility. Audit logs show API activity, which helps when troubleshooting an integration.

Use cases

Automating work: A nightly job uploads the latest product sheets to a corpus, using a key that can write only to Corpora.

Building integrations: Bring Ejento AI assistants into your own portal or internal tool, with a key scoped to the categories the integration uses.

Reporting: Pull chat logs into a dashboard with a Read Only key, so the dashboard can read data but never change it.

What you need to call the APIs

Server URL: Your organization's base URL for API requests.

Authorization Token: Sent in the request header as a Bearer token.

API key: A secret key with a permission scope, sent in the Ocp-Apim-Subscription-Key request header.

You'll find the Server URL and Authorization Token in Organization settings > API Keys, where you also create and manage keys.

Permission scopes

Scope	What it allows
All	Full read and write access to every API category.
Read Only	Only GET requests, across every category. No write access.
Restricted	Access chosen per API category: None, Read (GET only), or Write (all requests).

Choose the smallest scope that works. You can change a key's scope later without rotating the key.

Rate limits and quotas

API usage is limited by rate limits (calls per minute) and daily and monthly quotas, which depend on your role. The limits apply to all API keys. If they're exceeded, requests are temporarily blocked until the time window resets. Click Rate Limits & Quotas on the API Keys page to see your limits.

Audit logs

Click Show Logs on the API Keys page to open Audit Logs. It lists API requests with their time, subscription, method, operation, response code, error details, caller IP address, and URL.

API documentation

Every Ejento AI API is documented at api.ejento.ai, where you can explore endpoints, see request and response examples, and try requests in the interactive playground.

FAQs

What happens if I lose my secret key?

The secret key is shown only once, when you create it. If you lose it, create a new key and update your integration.

Does changing a key's permissions break the integrations that use it?

No. The key itself isn't rotated, so integrations keep working with the new permissions.

What happens when I revoke a key?

It's disabled immediately, and any requests that still use it are rejected. Update the systems that use it before you revoke it.

Ready to start? Follow How to generate API Key and Auth Token to get your credentials and create your first key.

Why API keys matter#

Use cases#

What you need to call the APIs#

Permission scopes#

Rate limits and quotas#

Audit logs#

API documentation#

FAQs#

What happens if I lose my secret key?#

Does changing a key's permissions break the integrations that use it?#

What happens when I revoke a key?#

Why API keys matter

Use cases

What you need to call the APIs

Permission scopes

Rate limits and quotas

Audit logs

API documentation

FAQs

What happens if I lose my secret key?

Does changing a key's permissions break the integrations that use it?

What happens when I revoke a key?