# LiveChatAI API Documentation

- [Introduction](https://api.livechatai.com/api-reference-v2/introduction.md): Welcome to LiveChatAI API v2 - Build powerful AI-powered customer support experiences
- [Create an agent](https://api.livechatai.com/api-reference-v2/agents/create.md): Create a new AI agent in your workspace
- [List agents](https://api.livechatai.com/api-reference-v2/agents/list.md): List all agents in your workspace. Supports pagination to help manage large datasets efficiently.
- [Retrieve an agent](https://api.livechatai.com/api-reference-v2/agents/retrieve.md): Retrieve a specific agent by ID or slug
- [Delete an agent](https://api.livechatai.com/api-reference-v2/agents/delete.md): Delete an agent permanently
- [List conversations](https://api.livechatai.com/api-reference-v2/conversations/list.md): List conversations for an agent, with pagination and filtering options. This endpoint supports various filters including date range, agent assignment, and conversation status.
- [List conversation views](https://api.livechatai.com/api-reference-v2/conversations/list-views.md): List all saved views for filtering conversations. Views are filter configurations created from the dashboard that can be used to filter conversations via the viewId parameter in the list conversations endpoint.
- [Create a conversation](https://api.livechatai.com/api-reference-v2/conversations/create.md): Create a new conversation without sending a message. This is a lightweight endpoint that only creates a contact and chat record, skipping AI processing, similarity search, and smart tag processing. Ideal for integrations that need a conversation ID quickly.
- [Send a message](https://api.livechatai.com/api-reference-v2/conversations/send-message.md): Send a message to start or continue a conversation with an agent
- [Retrieve a conversation](https://api.livechatai.com/api-reference-v2/conversations/retrieve.md): Retrieve details of a specific conversation including messages
- [Reply to a conversation](https://api.livechatai.com/api-reference-v2/conversations/reply.md): Send a reply message as an agent to a specific conversation. This endpoint allows agents to respond to customer messages and automatically updates conversation status.
- [Upload an attachment](https://api.livechatai.com/api-reference-v2/conversations/attachment-presign.md): Returns a short-lived presigned S3 POST (expires in 5 minutes / 300 seconds). Submit a multipart/form-data request to `uploadUrl` with every `fields` entry followed by the `file` field last; the `Content-Type` you send must match the one in `fields`, and S3 enforces the size limit server-side. Then…
- [Send an "agent is typing" indicator](https://api.livechatai.com/api-reference-v2/conversations/typing.md): Broadcast an ephemeral "agent is typing" indicator to the live chat widget for a specific conversation. Use this to show a typing animation in the messenger while your agent composes a reply in your own interface. The signal is not persisted: send it with isTyping=true while the agent is typing and…
- [End a conversation](https://api.livechatai.com/api-reference-v2/conversations/end.md): End a conversation. This endpoint allows agents to mark a conversation as resolved. If userId is not provided, the system will use the agent assigned to the chat, or if no agent is assigned, it will use the workspace owner associated with the API token.
- [Create or update a contact](https://api.livechatai.com/api-reference-v2/contacts/create.md): Create or update a contact for a specific agent. This endpoint allows you to identify users and associate them with chat sessions, enabling personalized experiences and contact tracking.
- [List contacts](https://api.livechatai.com/api-reference-v2/contacts/list.md): List all contacts for a specific agent. This endpoint supports pagination and filtering to help manage customer interactions efficiently.
- [List conversations for a contact](https://api.livechatai.com/api-reference-v2/contacts/list-conversations.md): List conversations for a specific contact with pagination and filtering options. Mirrors the response shape of `GET /api/v2/conversations`, scoped to a single contact.
- [Retrieve a contact](https://api.livechatai.com/api-reference-v2/contacts/retrieve.md): Retrieve detailed information about a specific contact, including their attributes and conversation history.
- [List data sources](https://api.livechatai.com/api-reference-v2/data-sources/list.md): List all data sources for an agent. This endpoint provides a unified view of all training data sources including websites, text, Q&A pairs, and uploaded files. It supports pagination, filtering, and search to help manage large datasets efficiently.
- [Create a text data source](https://api.livechatai.com/api-reference-v2/data-sources/create-text.md): Add a text-based data source to train your agent. Text data sources are useful for adding custom content, documentation, or knowledge base articles.
- [Create a URL data source](https://api.livechatai.com/api-reference-v2/data-sources/create-url.md): Add a website URL as a data source to train your agent. The system will crawl and extract content from the provided URL.
- [Create a Q&A data source](https://api.livechatai.com/api-reference-v2/data-sources/create-qa.md): Add a question and answer pair to train your agent. Q&A data sources are perfect for handling specific, frequently asked questions.
- [Create a file data source](https://api.livechatai.com/api-reference-v2/data-sources/create-file.md): Add file content (PDF, DOCX, or Image) as a data source to train your agent. The content should be pre-extracted from the file.
- [Update a Q&A data source](https://api.livechatai.com/api-reference-v2/data-sources/update-qa.md): Update an existing Q&A data source.
- [Delete data sources](https://api.livechatai.com/api-reference-v2/data-sources/delete.md): Delete one or more data sources from an agent. This endpoint supports both single and bulk deletion operations.
- [Get chatbot translations](https://api.livechatai.com/api-reference-v2/translations/list.md): Retrieve the full localization state for a chatbot, including the default language, supported languages, auto-translation flag, the static `availableKeys` catalogue listing every translation key the system recognises, and the merged translation fields (defaults + custom overrides) for every active l…
- [List available languages](https://api.livechatai.com/api-reference-v2/translations/list-languages.md): List all languages available for a chatbot. Returns predefined languages plus any custom languages that have translation overrides in the database.
- [Add a language](https://api.livechatai.com/api-reference-v2/translations/add-language.md): Add a language to the chatbot's supportedLanguages. Optionally seeds initial translation overrides for the new language. Fails with 409 if the language is already the default or already in supportedLanguages.
- [Remove a language](https://api.livechatai.com/api-reference-v2/translations/delete-language.md): Remove a language from the chatbot. Drops all translation overrides for the language, removes it from supportedLanguages, and clears it from the settings mirror. The default language cannot be removed.
- [Bulk update translations](https://api.livechatai.com/api-reference-v2/translations/update-bulk.md): Bulk upsert translations for a single language using merge semantics — only supplied keys are touched. Values equal to the language's default are removed from the database to keep storage clean (mirrors UI behavior).
- [Update a translation key](https://api.livechatai.com/api-reference-v2/translations/update-key.md): Update a single translation key for a single language. If the supplied value matches the language's default, the override is removed from the database (mirrors UI behavior).
- [Reset a translation key](https://api.livechatai.com/api-reference-v2/translations/delete-key.md): Reset a single translation key to its language default. Removes the override row from the database and re-syncs the settings mirror.
- [Update localization settings](https://api.livechatai.com/api-reference-v2/translations/update-settings.md): Update the chatbot's localization settings — default language, the supported-languages list, and the auto-translation flag. Any subset of fields may be provided; only supplied keys are touched.
- [List AI Suggestions](https://api.livechatai.com/api-reference-v2/ai-suggestions/list.md): List AI suggestions for a specific agent. AI suggestions are automatically generated improvement suggestions based on conversations where the AI response may have been incomplete, out of context, or lacking depth.
- [Retrieve AI Suggestion](https://api.livechatai.com/api-reference-v2/ai-suggestions/retrieve.md): Get detailed information about a specific AI suggestion including the user message, AI response, evaluation tag, potential gap, and suggested improvement.
- [Delete AI Suggestion](https://api.livechatai.com/api-reference-v2/ai-suggestions/delete.md): Delete (dismiss) an AI suggestion. This marks the suggestion as ignored and it will no longer appear in the suggestions list.
- [Get main analytics](https://api.livechatai.com/api-reference-v2/analytics/main.md): Get main analytics data for a chatbot including conversations, resolutions, responses, and daily breakdown
- [Get agent analytics](https://api.livechatai.com/api-reference-v2/analytics/agent.md): Get agent performance analytics including conversation counts, response times, and messages per conversation
- [Get AI function analytics](https://api.livechatai.com/api-reference-v2/analytics/ai-functions.md): Get AI function/action call analytics including success rates and per-function breakdown
- [Get CSAT analytics](https://api.livechatai.com/api-reference-v2/analytics/csat.md): Get CSAT (Customer Satisfaction) analytics including average scores, total responses, individual feedback entries with pagination, and period-over-period comparison
- [Get sentiment analytics](https://api.livechatai.com/api-reference-v2/analytics/sentiments.md): Get sentiment analysis breakdown with daily data for positive, negative, neutral, and unspecified sentiments
- [Get resolution analytics](https://api.livechatai.com/api-reference-v2/analytics/resolutions.md): Post-close judgement of whether conversations actually solved the customer's problem, broken down by verdict (RESOLVED / UNRESOLVED) and by who carried the conversation (AI / HUMAN_AGENT / NONE).
- [Get topics analytics](https://api.livechatai.com/api-reference-v2/analytics/topics.md): Get conversation topics analysis with daily breakdown showing top discussion topics
- [Introduction to LiveChatAI - DEPRECATED August 1, 2025](https://api.livechatai.com/api-reference/introduction.md): Enhance your website with intelligent conversational AI - This API version is deprecated
- [Get chat detail (public)](https://api.livechatai.com/api-reference/endpoint/chatbot/get-chat-detail-public.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Get chat detail
- [Get contact agents (public)](https://api.livechatai.com/api-reference/endpoint/chatbot/get-contact-agents-public.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Get contact agents
- [Create a new chatbot](https://api.livechatai.com/api-reference/endpoint/chatbot/create-a-new-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Create a new chatbot
- [Delete chatbot](https://api.livechatai.com/api-reference/endpoint/chatbot/delete-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Delete chatbot
- [Get chatbot detail (public)](https://api.livechatai.com/api-reference/endpoint/chatbot/get-chatbot-detail-public.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Get chatbot detail
- [Get user's chatbot](https://api.livechatai.com/api-reference/endpoint/chatbot/get-users-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Get user's chatbot
- [Message a Chatbot (public)](https://api.livechatai.com/api-reference/endpoint/chatbot/message-a-chatbot-public.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Message a Chatbot
- [Crawl websites to discover internal links](https://api.livechatai.com/api-reference/endpoint/chatbot/crawl-websites-to-discover-internal-links.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Crawl websites to discover internal links
- [Delete data-source from chatbot](https://api.livechatai.com/api-reference/endpoint/data-source/delete-data-source-from-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Delete data-source from chatbot
- [Get chatbot data-source items](https://api.livechatai.com/api-reference/endpoint/data-source/get-chatbot-data-source-items.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Get chatbot data-source items
- [Add pdf data-source to chatbot](https://api.livechatai.com/api-reference/endpoint/data-source/add-pdf-data-source-to-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Add pdf data-source to chatbot
- [Update Q&A data-source](https://api.livechatai.com/api-reference/endpoint/data-source/update-q&a-data-source.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Update Q&A data-source
- [Add Q&A data-source to chatbot](https://api.livechatai.com/api-reference/endpoint/data-source/add-q&a-data-source-to-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Add Q&A data-source to chatbot
- [Add text data-source to chatbot](https://api.livechatai.com/api-reference/endpoint/data-source/add-text-data-source-to-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Add text data-source to chatbot
- [Add url data-source to chatbot](https://api.livechatai.com/api-reference/endpoint/data-source/add-url-data-source-to-chatbot.md): **DEPRECATED:** This endpoint will be deprecated on August 1st, 2025. Please use the v1 API endpoints instead. Add url data-source to chatbot

## OpenAPI Specs

- [openapi](/api-reference-v2/openapi.json)
- [openapi](/api-reference/openapi.json)

## Optional

- [Documentation](https://help.livechatai.com/)
- [Community](https://discord.com/invite/X2WwkMVKt5)
- [Blog](https://livechatai.com/blog)