# Trillet AI

## Docs

- [Create Plant](https://trilletai.mintlify.app/api-reference/endpoint/create.md): Creates a new plant in the store
- [Delete Plant](https://trilletai.mintlify.app/api-reference/endpoint/delete.md): Deletes a single plant based on the ID supplied
- [Get Plants](https://trilletai.mintlify.app/api-reference/endpoint/get.md): Returns all plants from the system that the user has access to
- [Introduction](https://trilletai.mintlify.app/api-reference/introduction.md): Example section for showcasing API endpoints
- [Trillet Change Log](https://trilletai.mintlify.app/changelog/changelog.md): View the latest changes to Trillet
- [API Best Practices](https://trilletai.mintlify.app/documentation/best-practices.md): Guidelines for integrating with Trillet AI API
- [Webhook Integration Guide [Coming Soon]](https://trilletai.mintlify.app/documentation/inbound-call-webhook.md)
- [Introduction](https://trilletai.mintlify.app/documentation/introduction.md)
- [On-Premise Deployment](https://trilletai.mintlify.app/documentation/on-premise.md): Run Trillet in Your Own Infrastructure
- [Platform integrations](https://trilletai.mintlify.app/documentation/platform-integrations.md)
- [Quickstart Guide](https://trilletai.mintlify.app/documentation/quickstart.md): Complete guide to setting up your first AI agent in Trillet - from creating call flows to handling live calls
- [Text Chat Widget](https://trilletai.mintlify.app/documentation/web-integration/text-agent.md): Embed an AI-powered text chat widget on your website
- [Voice Agent Widget](https://trilletai.mintlify.app/documentation/web-integration/voice-agent.md): Embed an AI-powered voice agent on your website
- [Code Blocks](https://trilletai.mintlify.app/essentials/code.md): Display inline code and code blocks
- [Images and Embeds](https://trilletai.mintlify.app/essentials/images.md): Add image, video, and other HTML elements
- [Markdown Syntax](https://trilletai.mintlify.app/essentials/markdown.md): Text, title, and styling in standard markdown
- [Navigation](https://trilletai.mintlify.app/essentials/navigation.md): The navigation field in mint.json defines the pages that go in the navigation menu
- [Reusable Snippets](https://trilletai.mintlify.app/essentials/reusable-snippets.md): Reusable, custom snippets to keep content in sync
- [Global Settings](https://trilletai.mintlify.app/essentials/settings.md): Mintlify gives you complete control over the look and feel of your documentation using the mint.json file
- [Authentication](https://trilletai.mintlify.app/v1/api-reference/authentication.md): Learn how to authenticate your API requests
- [API Endpoints](https://trilletai.mintlify.app/v1/api-reference/endpoints.md): Complete reference for all Trillet AI API endpoints
- [End Active Call](https://trilletai.mintlify.app/v1/api-reference/endpoints/active-calls/end-call.md): End an active call by its room name.
- [Get Active Call Details](https://trilletai.mintlify.app/v1/api-reference/endpoints/active-calls/get.md): Retrieve detailed information about a specific active call including participants, transcript, and sentiment.
- [Get Call Insights](https://trilletai.mintlify.app/v1/api-reference/endpoints/active-calls/get-insights.md): Get AI-generated insights for an active call, including sentiment analysis and key topics.
- [List Active Calls](https://trilletai.mintlify.app/v1/api-reference/endpoints/active-calls/list.md): Retrieve all currently active calls in your workspace with real-time status information.
- [Remove AI Agent (Human Takeover)](https://trilletai.mintlify.app/v1/api-reference/endpoints/active-calls/remove-agent.md): Remove the AI agent from an active call to allow human takeover. The agent is muted rather than disconnected.
- [Create Call Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/call/create.md): Create a new agent for a workspace.
- [Delete Call Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/call/delete.md): Delete an existing agent
- [Get Call Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/call/get.md): Retrieve the details of a single call agent based on its unique identifier.
- [List Call Agents](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/call/list.md): Retrieve a list of all call agents with all their details.
- [Update Call Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/call/update.md): Update an existing agent
- [Create Omni Flow Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/omniflow/create.md): Create a new agent for a workspace.
- [Delete Omni Flow Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/omniflow/delete.md): Delete an existing agent
- [Get Omni Flow Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/omniflow/get.md): Retrieve the details of a single call agent based on its unique identifier.
- [List Omni Flow Agents](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/omniflow/list.md): Retrieve a list of all call agents with all their details.
- [Update Omni Flow Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/agents/omniflow/update.md): Update an existing agent
- [Create API Key](https://trilletai.mintlify.app/v1/api-reference/endpoints/api-keys/create.md): Generate a new API key for authenticating requests to the Trillet API.
- [Delete API Key](https://trilletai.mintlify.app/v1/api-reference/endpoints/api-keys/delete.md): Delete an API key. The key will immediately stop working for authentication.
- [List API Keys](https://trilletai.mintlify.app/v1/api-reference/endpoints/api-keys/list.md): Retrieve all API keys for the authenticated user.
- [Delete Call Disposition](https://trilletai.mintlify.app/v1/api-reference/endpoints/call-dispositions/delete.md): Delete or cancel a call disposition.
- [Export Call Dispositions CSV](https://trilletai.mintlify.app/v1/api-reference/endpoints/call-dispositions/export.md): Export call dispositions as a CSV file.
- [Get Call Disposition](https://trilletai.mintlify.app/v1/api-reference/endpoints/call-dispositions/get.md): Retrieve a specific call disposition by its ID.
- [List Call Dispositions](https://trilletai.mintlify.app/v1/api-reference/endpoints/call-dispositions/list.md): Retrieve a paginated list of call dispositions with filtering options.
- [Update Call Disposition](https://trilletai.mintlify.app/v1/api-reference/endpoints/call-dispositions/update.md): Update a call disposition, such as rescheduling a callback.
- [Cancel Batch Operation](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/cancel.md): Cancel a batch call operation and stop any remaining calls from being processed
- [Get Individual Call Status](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/get-call-status.md): Get the status of an individual call within a batch operation
- [Get Batch Progress](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/get-progress.md): Get detailed progress information for a batch call operation
- [Get Batch Status](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/get-status.md): Get detailed status information for a batch call operation
- [List Batch Calls](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/list-calls.md): Get a paginated list of all calls within a batch operation with optional status filtering
- [Batch Calls Overview](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/overview.md): Efficiently make multiple AI-powered calls using CSV data uploads
- [Start Batch Calls](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/batch/start.md): Initiate a batch call operation using a CSV file and specified agent
- [Export Call History CSV](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/export.md): Export call history records as a CSV file with optional transcript and post-analysis data.
- [Get a Specific Call History](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/get.md): Retrieve detailed information about a specific call history entry.
- [Get Phone Numbers](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/get-phoneNumber.md): Retrieve a list of phone numbers associated with the user.
- [List Call Histories](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/list.md): Retrieve a list of call history records in your workspace.
- [Get Call History Metrics](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/metrics.md): Retrieve aggregated metrics and analytics for call history records in your workspace.
- [Get Call Phonebook](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/call-history/phonebook.md): Retrieve the most frequently called phone numbers in your workspace.
- [Get Call Recording](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/get-recording.md): Retrieve audio recording for a completed call session.
- [Initiate Outbound Call](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/initiate-call.md): Send an AI-driven phone call to a given number.
- [Connect a Web Call](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/web/connect.md): Initiate a live web-based call session with an AI agent.
- [Disconnect a Web Call](https://trilletai.mintlify.app/v1/api-reference/endpoints/calls/web/disconnect.md): End an ongoing web-based call session.
- [Delete Conversation](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/deleteConvo.md): Delete a conversation from the database.
- [Delete Message](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/deleteMessage.md): Delete a message in a specific conversation from the database.
- [Edit Customer Details](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/editCustomerDetails.md): Edit customers details in a specific conversation.
- [Generate Message](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/generateMessage.md): Send an AI-generated message through either SMS or email to a specified recipient with optional metadata and dynamic configurations.
- [Get All Conversations](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/getAll.md): Fetch all conversations associated with the authenticated user.
- [Get Conversation By ID](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/getById.md): Fetch the message history and details for a specific conversation.
- [Get Conversations By Flow ID](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/getConvosByFlow.md): Fetch the conversations for a specific flow.
- [Handle Message Action](https://trilletai.mintlify.app/v1/api-reference/endpoints/conversations/messageAction.md): Edit or reject a specific message within a conversation.
- [Create Call Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/create.md): Create a new call flow with full settings.
- [Delete Call Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/delete.md): Permanently remove a call flow.
- [Get Call Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/get.md): Retrieve a specific call flow by its ID.
- [Delete Knowledge Base File](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/knowledgebase-delete.md): Delete a knowledge base file associated with a specific call flow.
- [Upload Knowledge Base File](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/knowledgebase-upload.md): Upload a knowledge base file to a specific call flow.
- [List Call Flows](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/list.md): Retrieve a list of all call flows in the workspace.
- [Update Call Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/call-flows/update.md): Update an existing call flow.
- [Create Message Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/create.md): Create a new message flow with full settings.
- [Delete Message Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/delete.md): Delete an existing message flow.
- [Get Message Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/get.md): Retrieve a specific message flow.
- [List Message Flows](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/list.md): Retrieve a list of all message flows.
- [Toggle Autopilot](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/toggle-autopilot.md): Toggle the autopilot mode of an existing message flow.
- [Update Message Flow](https://trilletai.mintlify.app/v1/api-reference/endpoints/flows/message-flows/update.md): Update an existing message flow with partial or full settings.
- [Add Flow to Folder](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/add-flow-to-folder.md): Add a flow to a specific folder identified by its folderId.
- [Create Flow Folder](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/create-folder.md): Create a new flow folder in the specified workspace.
- [Delete Folder](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/delete-folder.md): Delete a specific folder identified by its folderId and remove its reference from associated flows.
- [Get All Folders for Workspace](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/get-all-folders.md): Retrieve all folders associated with a specific workspace, identified by the workspace ID in the request header.
- [Get Folder Details with Flows](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/get-folder-details.md): Retrieve the details of a specific folder, including its associated flows, by its folderId.
- [Remove Flow from Folder](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/remove-flow-from-folder.md): Remove a specific flow from a folder identified by its folderId and flowId.
- [Update Folder](https://trilletai.mintlify.app/v1/api-reference/endpoints/folder/update-folder.md): Update the details of a specific folder identified by its folderId.
- [Disconnect GoHighLevel](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/ghl/disconnect.md): Disconnect GoHighLevel CRM integration from a call flow.
- [Install GoHighLevel](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/ghl/install.md): Get the GoHighLevel OAuth authorization URL to connect your GHL CRM.
- [Disconnect Google Calendar](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/google-calendar/disconnect.md): Disconnect Google Calendar integration from a call flow.
- [Install Google Calendar](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/google-calendar/install.md): Get the Google Calendar OAuth authorization URL to connect your Google Calendar.
- [List Google Calendars](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/google-calendar/list-calendars.md): List all available Google Calendars for the connected account.
- [Configure Meta Lead Ads](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-leads/configure.md): Configure Meta Lead Ads integration for a specific call flow. When a new lead is received, it automatically triggers a call.
- [Install Meta Lead Ads](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-leads/install.md): Get the Meta OAuth authorization URL to connect Meta Lead Ads for automatic lead calling.
- [Get Meta Lead Ads Status](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-leads/status.md): Check the connection and configuration status of Meta Lead Ads for a specific call flow.
- [Authorize Meta WhatsApp](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-whatsapp/authorize.md): Get the Meta OAuth authorization URL to connect your WhatsApp Business Account.
- [Disconnect Meta WhatsApp](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-whatsapp/disconnect.md): Disconnect the Meta WhatsApp Business integration from your workspace.
- [Get WhatsApp Connection Status](https://trilletai.mintlify.app/v1/api-reference/endpoints/integrations/meta-whatsapp/status.md): Check the current connection status of your Meta WhatsApp Business integration.
- [Add Text to Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/add-text.md): Add plain text content to an existing knowledge base.
- [Create Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/create.md): Create a new knowledge base in your workspace.
- [Delete Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/delete.md): Delete a knowledge base and all its associated files.
- [Get Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/get.md): Retrieve a specific knowledge base by its ID.
- [Get Knowledge Base Usage](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/get-usage.md): Retrieve usage information for a knowledge base, including which call flows are using it.
- [List Knowledge Bases](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/list.md): Retrieve all knowledge bases for a workspace.
- [Update Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/update.md): Update the name or description of an existing knowledge base.
- [Upload File to Knowledge Base](https://trilletai.mintlify.app/v1/api-reference/endpoints/knowledge-base/upload-file.md): Upload a file to an existing knowledge base. Supports PDF, TXT, DOCX, MD, CSV, and JSON files up to 50MB.
- [Get Available Countries](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/available-countries.md): Retrieve a list of countries where phone numbers are available for purchase.
- [Search Available Numbers](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/available-numbers.md): Search for available phone numbers in a specific country.
- [Get Phone Number Configuration](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/get-config.md): Retrieve the call flow and message flow configuration for a phone number.
- [Get Phone Number Price](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/get-price.md): Get the pricing for purchasing a phone number by country and type.
- [List Phone Numbers](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/list.md): Retrieve all phone numbers associated with your workspace.
- [Purchase Phone Number](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/purchase.md): Purchase a phone number for your workspace.
- [Release Phone Number](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/release.md): Release (cancel) a phone number from your workspace.
- [Update Phone Number Configuration](https://trilletai.mintlify.app/v1/api-reference/endpoints/phone-numbers/update-config.md): Update the call flow configuration for a phone number, including agent assignment, recording, and office hours.
- [Get Recording](https://trilletai.mintlify.app/v1/api-reference/endpoints/recordings/get.md): Stream the audio recording for a specific call. Returns the recording file with appropriate audio headers.
- [Start Recording](https://trilletai.mintlify.app/v1/api-reference/endpoints/recordings/start.md): Start recording an active call.
- [Create Role](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/create.md): Create a new role with specific permissions for your workspace.
- [Delete Role](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/delete.md): Delete a role from your workspace.
- [Get Role](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/get.md): Retrieve a specific role by its ID.
- [List Roles](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/list.md): Retrieve all roles defined in your workspace.
- [List Available Permissions](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/list-permissions.md): Retrieve all available permissions that can be assigned to roles.
- [Update Role](https://trilletai.mintlify.app/v1/api-reference/endpoints/roles/update.md): Update an existing role's name, description, or permissions.
- [Assign Phone Number to Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/telephony/bind-call-to-phoneNumber.md): Assign a specific phone number to an agent's call flow, configure recording options, office hours, metadata, and automatically update SIP trunks.
- [Bring Your Own Number](https://trilletai.mintlify.app/v1/api-reference/endpoints/telephony/register-externalNumber.md): Register your own external phone number with Twilio to use within your workspace.
- [Unassign Phone Number from Agent](https://trilletai.mintlify.app/v1/api-reference/endpoints/telephony/unbind-call-to-phoneNumber.md): Unassign a phone number from an agent's call flow. This removes the assignment and automatically cleans up associated SIP trunking.
- [Clone Voice](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/clone.md): Clone a voice from an audio file to create a custom voice with a unique voice embedding.
- [Create Custom Voice](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/create.md): Create a custom voice using a voice embedding.
- [Delete Voice](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/delete.md): Delete a custom voice from your workspace.
- [Get Voice](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/get.md): Retrieve a specific voice by its ID.
- [List Custom Voices](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/list-custom.md): Retrieve all custom voices created in your workspace.
- [Search Voices](https://trilletai.mintlify.app/v1/api-reference/endpoints/voices/search.md): Search available voices by name, category, gender, accent, age, use case, or provider.
- [Create Workspace](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/create-workspace.md): Create a new workspace with the authenticated user as the owner.
- [Delete Workspace](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/delete-workspace.md): Delete an existing workspace. Only the owner of the workspace can delete it. Master workspaces and the user's only remaining workspace cannot be deleted.
- [Get Pending Invitations](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/get-pending-invitation.md): Retrieve a list of pending workspace invitations for the authenticated user.
- [List User Workspaces](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/get-workspace.md): Retrieve all workspaces associated with the authenticated user. If the user does not exist, a new user and default workspace may be automatically created.
- [Get Workspace by ID](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/get-workspace-by-id.md): Retrieve detailed information about a specific workspace where the authenticated user is either the owner or a team member.
- [Invite Team Member](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/invite-team-member.md): Invite a new team member to join a workspace. Only workspace owners can send invitations.
- [Update Workspace Name](https://trilletai.mintlify.app/v1/api-reference/endpoints/workspace/update-name.md): Update the name of an existing workspace. Only the owner of the workspace is authorized to perform this action.
- [API Reference](https://trilletai.mintlify.app/v1/api-reference/introduction.md): Complete reference for the Trillet AI Platform API

## OpenAPI Specs

- [openapi](https://trilletai.mintlify.app/api-reference/openapi.json)