Alkimi AI Logo Alkimi AI

API Documentation

Explore our API to integrate your applications with Alkimi.

Getting Started

Authentication

All requests to the Alkimi API must be authenticated using an API token. You can generate and manage your API tokens from your account settings. Include your token in the Authorization header using the Bearer scheme. 

Authorization: Bearer YOUR_API_TOKEN

Making a Request

All API endpoints are versioned. The current version is v1 , which must be included in the URL path.

Here’s a quick example using curl to fetch your user details. Replace YOUR_API_TOKEN with your actual API key. 

curl -X GET https://api.alkimi.ai/v1/user \
-H "Authorization: Bearer YOUR_API_TOKEN"

Users

Base Path: https://api.alkimi.com/v1/users

Organizations

Base Path: https://api.alkimi.com/v1/organizations

Invitations

Base Path: https://api.alkimi.com/v1/invitations

Agents

Base Path: https://api.alkimi.com/v1/agents

Chats

Base Path: https://api.alkimi.com/v1/chats

Shares

Base Path: https://api.alkimi.com/v1/shares

Messages

Base Path: https://api.alkimi.com/v1/chats/:chatId/messages

Knowledge

Base Path: https://api.alkimi.com/v1/knowledge

Permissions

Base Path: https://api.alkimi.com/v1/permissions

Schemas