# Chat Engine

## Docs

- [Create a new agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents-v2/create-a-new-agent.md)
- [Get all agents](https://sadaa-docs.actualize.ae/chat-engine-api/agents-v2/get-all-agents.md)
- [Create a new agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/create-a-new-agent.md)
- [Delete an agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/delete-an-agent.md)
- [Generates agent questions](https://sadaa-docs.actualize.ae/chat-engine-api/agents/generates-agent-questions.md)
- [Get agents default values](https://sadaa-docs.actualize.ae/chat-engine-api/agents/get-agents-default-values.md)
- [Get all agents](https://sadaa-docs.actualize.ae/chat-engine-api/agents/get-all-agents.md)
- [Get an agent by id](https://sadaa-docs.actualize.ae/chat-engine-api/agents/get-an-agent-by-id.md)
- [Get public agent details by ID](https://sadaa-docs.actualize.ae/chat-engine-api/agents/get-public-agent-details-by-id.md)
- [Remove knowledge store from agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/remove-knowledge-store-from-agent.md)
- [Remove tool from agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/remove-tool-from-agent.md)
- [Remove voice config from agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/remove-voice-config-from-agent.md)
- [Update an agent](https://sadaa-docs.actualize.ae/chat-engine-api/agents/update-an-agent.md)
- [Close a chat session](https://sadaa-docs.actualize.ae/chat-engine-api/chat/close-a-chat-session.md)
- [Create a new chat session](https://sadaa-docs.actualize.ae/chat-engine-api/chat/create-a-new-chat-session.md)
- [Get a chat session by ID](https://sadaa-docs.actualize.ae/chat-engine-api/chat/get-a-chat-session-by-id.md)
- [Get chat by agent Id](https://sadaa-docs.actualize.ae/chat-engine-api/chat/get-chat-by-agent-id.md)
- [List all Events of the chat](https://sadaa-docs.actualize.ae/chat-engine-api/chat/list-all-events-of-the-chat.md)
- [List all messages of the chat](https://sadaa-docs.actualize.ae/chat-engine-api/chat/list-all-messages-of-the-chat.md)
- [List chat sessions](https://sadaa-docs.actualize.ae/chat-engine-api/chat/list-chat-sessions.md)
- [Send a message to the chat](https://sadaa-docs.actualize.ae/chat-engine-api/chat/send-a-message-to-the-chat.md)
- [Create a new voice session](https://sadaa-docs.actualize.ae/chat-engine-api/create-a-new-voice-session.md)
- [Get all agent summary stats for usage meter](https://sadaa-docs.actualize.ae/chat-engine-api/get-all-agent-summary-stats-for-usage-meter.md)
- [Get all user stats for usage meter](https://sadaa-docs.actualize.ae/chat-engine-api/get-all-user-stats-for-usage-meter.md)
- [Get apiv1health](https://sadaa-docs.actualize.ae/chat-engine-api/get-apiv1health.md)
- [Get apiv1whatsapp](https://sadaa-docs.actualize.ae/chat-engine-api/get-apiv1whatsapp.md)
- [Get meters](https://sadaa-docs.actualize.ae/chat-engine-api/meters/get-meters.md)
- [Get model usage meters](https://sadaa-docs.actualize.ae/chat-engine-api/meters/get-model-usage-meters.md)
- [Ingest event for model usage](https://sadaa-docs.actualize.ae/chat-engine-api/meters/ingest-event-for-model-usage.md)
- [Create a new model/models](https://sadaa-docs.actualize.ae/chat-engine-api/models/create-a-new-modelmodels.md)
- [Delete a model](https://sadaa-docs.actualize.ae/chat-engine-api/models/delete-a-model.md)
- [Get a model by id](https://sadaa-docs.actualize.ae/chat-engine-api/models/get-a-model-by-id.md)
- [Get all models](https://sadaa-docs.actualize.ae/chat-engine-api/models/get-all-models.md)
- [Update a model](https://sadaa-docs.actualize.ae/chat-engine-api/models/update-a-model.md)
- [Update a model pricing](https://sadaa-docs.actualize.ae/chat-engine-api/models/update-a-model-pricing.md)
- [Generate onboarding code](https://sadaa-docs.actualize.ae/chat-engine-api/onboarding/generate-onboarding-code.md)
- [Onboard twilio whatsapp account](https://sadaa-docs.actualize.ae/chat-engine-api/onboarding/onboard-twilio-whatsapp-account.md)
- [Retrieve onboarding record by code](https://sadaa-docs.actualize.ae/chat-engine-api/onboarding/retrieve-onboarding-record-by-code.md)
- [Create a new phone number](https://sadaa-docs.actualize.ae/chat-engine-api/phone-numbers/create-a-new-phone-number.md)
- [Delete a phone number](https://sadaa-docs.actualize.ae/chat-engine-api/phone-numbers/delete-a-phone-number.md)
- [Get all phone numbers](https://sadaa-docs.actualize.ae/chat-engine-api/phone-numbers/get-all-phone-numbers.md)
- [Map a phone number to an agent](https://sadaa-docs.actualize.ae/chat-engine-api/phone-numbers/map-a-phone-number-to-an-agent.md)
- [Start an outbound call](https://sadaa-docs.actualize.ae/chat-engine-api/phone-numbers/start-an-outbound-call.md): Start an outbound call using either agentId or agentPhoneNumberId. If agentId is provided, it will use the active phone number mapped to that agent.
- [Post apiv1whatsappreceive](https://sadaa-docs.actualize.ae/chat-engine-api/post-apiv1whatsappreceive.md)
- [Send a voice message as text](https://sadaa-docs.actualize.ae/chat-engine-api/send-a-voice-message-as-text.md)
- [Create a new tool](https://sadaa-docs.actualize.ae/chat-engine-api/tools/create-a-new-tool.md)
- [Delete a tool](https://sadaa-docs.actualize.ae/chat-engine-api/tools/delete-a-tool.md)
- [Get a tool by ID](https://sadaa-docs.actualize.ae/chat-engine-api/tools/get-a-tool-by-id.md)
- [Get all tools](https://sadaa-docs.actualize.ae/chat-engine-api/tools/get-all-tools.md)
- [Get Tool default configurations](https://sadaa-docs.actualize.ae/chat-engine-api/tools/get-tool-default-configurations.md)
- [Update an existing tool](https://sadaa-docs.actualize.ae/chat-engine-api/tools/update-an-existing-tool.md)
- [Broadcast event to all endpoints](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/broadcast-event-to-all-endpoints.md): This creates a new message with the event type, which broadcasts it to all the endpoints connected to that event type     Note: This is a management API and requires api-key
- [Create Event types for webhook](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/create-event-types-for-webhook.md): This creates an event-type for the webhooks, mainly used for introducing new events     Note: This is a management API and requires api-key
- [Create New Application](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/create-new-application.md): This creates a new application for configuring webhooks, mainly used for multi tenancy purpose     Note: This is a management API and requires api-key
- [Create webhook endpoint with events](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/create-webhook-endpoint-with-events.md): This creates a new webhook endpoint, mainly used to create endpoint with event mapping     Note: This is a management API and requires api-key
- [Delete Event type for webhook](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/delete-event-type-for-webhook.md): This deletes an event type, this is a soft delete and only marks event as archived: true     Note: This is a management API and requires api-key
- [Delete webhook endpoint](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/delete-webhook-endpoint.md): This deletes an endpoint, this is a soft delete and only marks endpoint as archived: true     Note: This is a management API and requires api-key
- [Get Event types for webhook](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/get-event-types-for-webhook.md): This lists all the event types in the webhooks configurations     Note: This is a management API and requires api-key
- [Information about webhook endpoint](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/information-about-webhook-endpoint.md): This endpoint returns information related to an endpoint, can be used to check the messages sent to the particular endpoint     Note: This is a management API and requires api-key
- [List webhook endpoints](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/list-webhook-endpoints.md): This lists all the endpoints for an application     Note: This is a management API and requires api-key
- [Retrieve all applications](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/retrieve-all-applications.md): This retrives all the application for the webhooks configuation     Note: This is a management API and requires api-key
- [Update Event type for webhook](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/update-event-type-for-webhook.md): This updates an existing event type by name     Note: This is a management API and requires api-key
- [Update webhook endpoint with events](https://sadaa-docs.actualize.ae/chat-engine-api/webhooks/update-webhook-endpoint-with-events.md): This updates existing endpointfor an application     Note: This is a management API and requires api-key
- [Delete apiv1whatsapp tenant configs](https://sadaa-docs.actualize.ae/chat-engine-api/whatsapp-tenant-configs/delete-apiv1whatsapp-tenant-configs.md)
- [Get apiv1whatsapp tenant configs](https://sadaa-docs.actualize.ae/chat-engine-api/whatsapp-tenant-configs/get-apiv1whatsapp-tenant-configs.md)
- [Get apiv1whatsapp tenant configs 1](https://sadaa-docs.actualize.ae/chat-engine-api/whatsapp-tenant-configs/get-apiv1whatsapp-tenant-configs-1.md)
- [Patch apiv1whatsapp tenant configs](https://sadaa-docs.actualize.ae/chat-engine-api/whatsapp-tenant-configs/patch-apiv1whatsapp-tenant-configs.md)
- [Post apiv1whatsapp tenant configstypetwilio](https://sadaa-docs.actualize.ae/chat-engine-api/whatsapp-tenant-configs/post-apiv1whatsapp-tenant-configstypetwilio.md)
- [Platform Overview](https://sadaa-docs.actualize.ae/documentation/introduction.md): Enterprise-grade Conversational AI Platform for Seamless Customer Interactions
- [API Integration](https://sadaa-docs.actualize.ae/documentation/quickstart/api-integration.md): Create and manage AI agents programmatically
- [Dashboard Setup](https://sadaa-docs.actualize.ae/documentation/quickstart/dashboard-setup.md): Learn how to create your first agent from UI
- [Getting Started](https://sadaa-docs.actualize.ae/documentation/quickstart/overview.md): Learn how to create and deploy your first AI agent
- [Testing Your Agent](https://sadaa-docs.actualize.ae/documentation/quickstart/testing-your-agent.md): Learn how to test your AI agent through chat and voice interfaces
- [Welcome to Sadaa](https://sadaa-docs.actualize.ae/documentation/welcome.md)
- [Create Document](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/create-document.md): Create a new document.
- [Delete Document](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/delete-document.md): Delete a document by its ID.
- [Download The Document](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/download-the-document.md): Download a document by its ID.
- [Edit Document](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/edit-document.md): Edit a document.
- [Get Document By Id](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/get-document-by-id.md): Get a document by its ID.
- [List Documents](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/list-documents.md): List all documents.
- [Upload Document](https://sadaa-docs.actualize.ae/knowledge-base-api/documents/upload-document.md): Upload a file to create a new document.
- [List All Embeddings](https://sadaa-docs.actualize.ae/knowledge-base-api/embeddings/list-all-embeddings.md)
- [Health](https://sadaa-docs.actualize.ae/knowledge-base-api/health.md): Health check endpoint for the API.
- [Get Parser Types](https://sadaa-docs.actualize.ae/knowledge-base-api/parsers/get-parser-types.md)
- [List All Parsers](https://sadaa-docs.actualize.ae/knowledge-base-api/parsers/list-all-parsers.md)
- [Root](https://sadaa-docs.actualize.ae/knowledge-base-api/root.md): Root endpoint of the API.
- [List All Splitters](https://sadaa-docs.actualize.ae/knowledge-base-api/splitters/list-all-splitters.md): List all supported Splitters in the system.
- [Create A New Document Store.](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/create-a-new-document-store.md): Create a new document store.
- [Create Document Loader](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/create-document-loader.md): Create a new document loader.
- [Delete Document Loader](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/delete-document-loader.md): Delete a document loader by its ID.
- [Delete Document Store By Id](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/delete-document-store-by-id.md): Delete a document store by its ID.
- [Get Document Loader By Id](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/get-document-loader-by-id.md): Get a document loader by its ID.
- [Get Document Store By Id](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/get-document-store-by-id.md): Get a document store by its ID.
- [List Document Loaders](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/list-document-loaders.md): List all document loaders.
- [List Document Stores](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/list-document-stores.md): List all document stores. Allows 'skip' and 'limit' parameters for pagination.
- [Process Document Store And Vectorize Documents](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/process-document-store-and-vectorize-documents.md): ⚠️ This endpoint is deprecated and will be removed in v2.0.0. Please use {store_id}/process instead.
- [Process Document Store And Vectorize Documents](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/process-document-store-and-vectorize-documents-1.md)
- [Search Indexed Documents In Document Store](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/search-indexed-documents-in-document-store.md): Search indexed documents in Document Store
- [Update Document Loader](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/update-document-loader.md): Update a document loader.
- [Update Document Store](https://sadaa-docs.actualize.ae/knowledge-base-api/stores/update-document-store.md): Update Document Store.
- [Health Check](https://sadaa-docs.actualize.ae/voice-api/health/health-check.md): Health check endpoint.
- [Get available AI models](https://sadaa-docs.actualize.ae/voice-api/models/get-available-ai-models.md): Retrieve a list of available AI models across different providers and categories
- [Create Phone Number](https://sadaa-docs.actualize.ae/voice-api/phone-numbers/create-phone-number.md): Purchase a new phone number from specified provider.
- [Delete Phone Number](https://sadaa-docs.actualize.ae/voice-api/phone-numbers/delete-phone-number.md): Delete a phone number and associated resources.
- [Delete Room](https://sadaa-docs.actualize.ae/voice-api/phone-numbers/delete-room.md): Close a room.
- [Init Phone Call](https://sadaa-docs.actualize.ae/voice-api/phone-numbers/init-phone-call.md): Initiate a sip call
- [Start Phone Call](https://sadaa-docs.actualize.ae/voice-api/phone-numbers/start-phone-call.md): Initiate a sip call
- [Create Playground Room Token](https://sadaa-docs.actualize.ae/voice-api/tokens/create-playground-room-token.md)
- [Get available voices](https://sadaa-docs.actualize.ae/voice-api/voices/get-available-voices.md): Retrieve a list of available voices for each provider

## OpenAPI Specs

- [openapi](https://sadaa-docs.actualize.ae/api-reference/openapi.json)
- [openapi-from-anchor-url-2](https://sadaa-docs.actualize.ae/openapi-from-anchor-url-2)
- [openapi-from-tab-2](https://sadaa-docs.actualize.ae/openapi-from-tab-2)
- [openapi-from-tab-1](https://sadaa-docs.actualize.ae/openapi-from-tab-1)
- [openapi-from-anchor-url-1](https://sadaa-docs.actualize.ae/openapi-from-anchor-url-1)
- [openapi-from-tab-0](https://sadaa-docs.actualize.ae/openapi-from-tab-0)
- [openapi-from-anchor-url-3](https://sadaa-docs.actualize.ae/openapi-from-anchor-url-3)
- [openapi-from-url-b0d91c3d-4d7a-4def-8356-085b3b63ee12](https://sadaa-docs.actualize.ae/openapi-from-url-b0d91c3d-4d7a-4def-8356-085b3b63ee12)
- [openapi-from-url-d0e7e567-cf86-497a-b611-40a4668cdeac](https://sadaa-docs.actualize.ae/openapi-from-url-d0e7e567-cf86-497a-b611-40a4668cdeac)
- [openapi-from-url-a5371106-2faa-499a-b2a8-b29a0b593689](https://sadaa-docs.actualize.ae/openapi-from-url-a5371106-2faa-499a-b2a8-b29a0b593689)

## Optional

- [Join our Community](https://locai-workspace.slack.com/archives/C087RJF83EJ)
- [GitHub](https://github.com/LocAI1/mira-chat-engine)