# Interactly API

## Docs

- [API Keys](https://docs.interactly.ai/api-reference/api-keys.md): Here you'll find steps to get API keys to use in our API Reference.
- [Create Assistant](https://docs.interactly.ai/api-reference/assistants/create-assistant.md): To create an assistant.
- [Delete Assistant](https://docs.interactly.ai/api-reference/assistants/delete-assistant.md): Delete Assistant by ID
- [Get Assistant](https://docs.interactly.ai/api-reference/assistants/get-assistant.md): Get Assistant Details by ID
- [List Assistants](https://docs.interactly.ai/api-reference/assistants/list-assistants.md): List Assistants
- [Update Assistant](https://docs.interactly.ai/api-reference/assistants/update-assistant.md): Update Assistant Details by ID
- [Connect Call](https://docs.interactly.ai/api-reference/calls/connect-call.md): Connect your call with Interactly.
- [Control Call](https://docs.interactly.ai/api-reference/calls/control-call.md): This API will allow you to control the call.
- [Create Call](https://docs.interactly.ai/api-reference/calls/create-call.md): This API will create a new call. The call will be initiated and the call details will be returned. Call will be outbound call from assistant to the user.
- [Get Call](https://docs.interactly.ai/api-reference/calls/get-call.md): Get Call By ID. This API will return the call details along with the messages.
- [List Calls](https://docs.interactly.ai/api-reference/calls/list-calls.md): This API will return the list of calls based on the filter criteria.
- [Bulk Call Status](https://docs.interactly.ai/api-reference/campaigns/campaign-bulk-calls/bulk-call-status.md): Get the status of multiple campaign calls in bulk. - **callIds**: A list of campaign call IDs to retrieve statuses for.
- [Create Campaigns Calls](https://docs.interactly.ai/api-reference/campaigns/campaign-bulk-calls/create-campaigns-calls.md): Create a new campaign call configuration in bulk. - **body**: The campaign call configuration data. - **config**: Configuration options for the campaign call. - **data**: List of campaign call data to be processed in bulk.
- [Get Call By Call Id](https://docs.interactly.ai/api-reference/campaigns/campaign-bulk-calls/get-call-by-call-id.md): Get the status of a campaign call by its ID. - **call_id**: The ID of the campaign call to retrieve.
- [Get Campaign Call Stats](https://docs.interactly.ai/api-reference/campaigns/campaign-stats/get-campaign-call-stats.md): Get aggregated stats for campaign calls. - **group_by**: "outcome" (default), "status", or "status_outcome". - **campaign_id**: Optional campaign ID to scope to a single campaign. - **statuses**: Repeatable filter — ?statuses=completed&statuses=failed. - **outcomes**: Repeatable filter — ?outcomes=v…
- [Get Campaign Stats](https://docs.interactly.ai/api-reference/campaigns/campaign-stats/get-campaign-stats.md): Get aggregated stats for campaigns. - **group_by**: "status" (default), "source", or "campaignType". - **statuses**: Repeatable filter — ?statuses=completed&statuses=processing. - **start** / **end**: Optional datetime range filter.
- [Create Campaigns Calls](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/create-campaigns-calls.md): Use this API to add/upload a batch of calls for the specified campaign configuration. This API can be used to add calls while campaign is running also. - **campaign_id**: The ID of the campaign configuration.
- [Delete Call By Call Id](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/delete-call-by-call-id.md): Delete a call by its ID in a campaign. - **campaign_id**: The ID of the campaign configuration. - **call_id**: The ID of the call to delete.
- [Download Calls Route](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/download-calls-route.md): Download calls for a given campaign configuration. - **config_id**: The ID of the campaign configuration. - **body**: The request body containing filters for downloading calls.
- [Get Call By Call Id](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/get-call-by-call-id.md): Get a call by its ID in a campaign. - **campaign_id**: The ID of the campaign configuration. - **call_id**: The ID of the call to retrieve.
- [Get Campaigns Call List](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/get-campaigns-call-list.md): Get a list of calls in a campaign. - **campaign_id**: The ID of the campaign configuration. - **start**: Start date/time for filtering calls. - **end**: End date/time for filtering calls. - **status**: Optional status to filter calls. - **search**: Optional search term to filter calls. - **page**: P…
- [Get Campaigns Calls Count](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/get-campaigns-calls-count.md): Get the count of calls in a campaign. - **campaign_id**: The ID of the campaign configuration. - **start**: Start date/time for filtering calls. - **end**: End date/time for filtering calls. - **search**: Optional search term to filter calls.
- [Patch Call By Call Id](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/patch-call-by-call-id.md): Patch a call by its ID in a campaign. - **campaign_id**: The ID of the campaign configuration. - **call_id**: The ID of the call to patch. - **body**: The request body containing fields to update.
- [Send Campaign Report](https://docs.interactly.ai/api-reference/campaigns/campaigns-calls/send-campaign-report.md): Send campaign report email for the given campaign configuration ID. - **config_id**: The ID of the campaign configuration.
- [Action Campaign By Id](https://docs.interactly.ai/api-reference/campaigns/campaigns/action-campaign-by-id.md): Perform an action on a campaign configuration by ID. - **campaign_id**: The ID of the campaign configuration to update. - **body**: The action request containing the action to perform on the campaign.
- [Clone Campaign By Id](https://docs.interactly.ai/api-reference/campaigns/campaigns/clone-campaign-by-id.md): Clone a campaign: creates a new campaign with the same config and clones filtered calls in the background. - **campaign_id**: The ID of the source campaign to clone. - **body**: Clone options including name, schedule override, and call filters.
- [Create Campaigns](https://docs.interactly.ai/api-reference/campaigns/campaigns/create-campaigns.md): Create a new campaign configuration. - **body**: The campaign configuration data.
- [Delete Campaign With Id](https://docs.interactly.ai/api-reference/campaigns/campaigns/delete-campaign-with-id.md): Delete a campaign configuration by ID. - **campaign_id**: The ID of the campaign configuration to delete.
- [Get Campaign By Id](https://docs.interactly.ai/api-reference/campaigns/campaigns/get-campaign-by-id.md): Fetch campaign by id - **campaign_id**: The ID of the campaign configuration to fetch.
- [Get Campaigns](https://docs.interactly.ai/api-reference/campaigns/campaigns/get-campaigns.md): Fetch campaigns with optional filters. - **pagination**: Pagination parameters including page, size, and search term. - **start**: Optional start date for filtering campaigns. - **end**: Optional end date for filtering campaigns. - **status**: Optional status to filter campaigns by their current sta…
- [Patch Campaign With Id](https://docs.interactly.ai/api-reference/campaigns/campaigns/patch-campaign-with-id.md): Update a campaign configuration by ID. - **campaign_id**: The ID of the campaign configuration to update. - **body**: The fields to update in the campaign configuration.
- [Create New Contact](https://docs.interactly.ai/api-reference/campaigns/contacts/create-new-contact.md): Create a new contact for the team. - **body**: The contact data including first_name, last_name, phone_number, and optional email and dob.
- [Delete Contact](https://docs.interactly.ai/api-reference/campaigns/contacts/delete-contact.md): Delete a contact by ID. - **contact_id**: The ID of the contact to delete.
- [Get Contact By Id](https://docs.interactly.ai/api-reference/campaigns/contacts/get-contact-by-id.md): Fetch a contact by ID. - **contact_id**: The ID of the contact to fetch.
- [Get Contacts](https://docs.interactly.ai/api-reference/campaigns/contacts/get-contacts.md): Fetch all contacts for the team with optional search and pagination. - **pagination**: Pagination parameters including page, size, and optional search term.
- [Get Contacts Stats](https://docs.interactly.ai/api-reference/campaigns/contacts/get-contacts-stats.md): Fetch statistics about contacts for the team.
- [Update Contact](https://docs.interactly.ai/api-reference/campaigns/contacts/update-contact.md): Update a contact by ID. - **contact_id**: The ID of the contact to update. - **body**: The fields to update.
- [Delete File](https://docs.interactly.ai/api-reference/files/delete-file.md): Delete File
- [Get File](https://docs.interactly.ai/api-reference/files/get-file.md): Get File
- [List Files](https://docs.interactly.ai/api-reference/files/list-files.md): Lists the files available to upload in a knowledge base.
- [Upload File](https://docs.interactly.ai/api-reference/files/upload-file.md): Upload File
- [Create Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/create-knowledge-base.md): Create Knowledge Base
- [Delete Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/delete-knowledge-base.md): Delete Knowledge Base
- [Fetch the FAQ template for a knowledge base](https://docs.interactly.ai/api-reference/knowledge-bases/fetch-the-faq-template-for-a-knowledge-base.md): Returns a list of frequently asked questions along with their answers
- [Get Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/get-knowledge-base.md): Get Knowledge Base
- [Get Knowledge Base Status](https://docs.interactly.ai/api-reference/knowledge-bases/get-knowledge-base-status.md): Get Knowledge Base Status
- [Insert new questions and answers into FAQ template for a knowledge base](https://docs.interactly.ai/api-reference/knowledge-bases/insert-new-questions-and-answers-into-faq-template-for-a-knowledge-base.md): Returns a list of frequently asked questions along with their answers
- [List Knowledge Bases](https://docs.interactly.ai/api-reference/knowledge-bases/list-knowledge-bases.md): List Knowledge Bases
- [Query Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/query-knowledge-base.md): Send a question to the specified knowledge base and receive a response. Optionally pass a conversation history for the assistant to take into consideration while generating responses.
- [Remove questions from FAQ](https://docs.interactly.ai/api-reference/knowledge-bases/remove-questions-from-faq.md): Remove questions and answers from existing FAQ sheet.  The question IDs can be a sent in the query parameters.
- [Train Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/train-knowledge-base.md): Send a trigger to train the knowledge base again
- [Update Knowledge Base](https://docs.interactly.ai/api-reference/knowledge-bases/update-knowledge-base.md): Update Knowledge Base
- [Update questions and answers in FAQ template for a knowledge base](https://docs.interactly.ai/api-reference/knowledge-bases/update-questions-and-answers-in-faq-template-for-a-knowledge-base.md): Update a list of QnA entries in an FAQ by their unique ID
- [Delete Number](https://docs.interactly.ai/api-reference/phone-numbers/delete-number.md): Deletes a number by its ID.
- [Import Number](https://docs.interactly.ai/api-reference/phone-numbers/import-number.md): Import number from provider. Please add provider credentials in the provider credentials section before you import an phone number.
- [List Numbers](https://docs.interactly.ai/api-reference/phone-numbers/list-numbers.md): Get list of Numbers purchased
- [List Purchasable Numbers](https://docs.interactly.ai/api-reference/phone-numbers/list-purchasable-numbers.md): Retrieves a list of numbers available for purchase.
- [Purchase Number](https://docs.interactly.ai/api-reference/phone-numbers/purchase-number.md): Purchases a number.
- [Update Number](https://docs.interactly.ai/api-reference/phone-numbers/update-number.md): To attach or detach assistant to the number, or enable or disable the inbound/outbound call.
- [Create Tool](https://docs.interactly.ai/api-reference/tools/create-tool.md)
- [Delete Tool](https://docs.interactly.ai/api-reference/tools/delete-tool.md)
- [Get Tool](https://docs.interactly.ai/api-reference/tools/get-tool.md)
- [List Tools](https://docs.interactly.ai/api-reference/tools/list-tools.md)
- [Update Tool](https://docs.interactly.ai/api-reference/tools/update-tool.md)
- [Server Message](https://docs.interactly.ai/api-reference/webhooks/server-message.md): These are all the messages that can be sent to your server before, after and during the call.
- [Assistant Tools](https://docs.interactly.ai/assistant-tools/introduction.md): Learn how to configure and enable custom tool integrations to enhance your AI assistant's capabilities with your own business logic and APIs
- [Testing Tools](https://docs.interactly.ai/assistant-tools/testing-tools.md): Use the built-in test runner on the Interactly platform to test your custom tool integrations and troubleshoot configuration issues
- [Live Call Control](https://docs.interactly.ai/calls/call-features.md)
- [DND & Callback](https://docs.interactly.ai/campaigns/dnd-and-callback.md): A comprehensive guide to understanding Do Not Disturb (DND) preferences and automated callback scheduling for your campaigns.
- [Campaigns](https://docs.interactly.ai/campaigns/introduction.md): Learn about campaign features, types, and choose between single-modal voice-only campaigns and multi-modal campaigns with messaging
- [Multi-Modal Campaign](https://docs.interactly.ai/campaigns/multi-modal-campaign.md): Learn how to set up multi-modal campaigns that combine AI voice calls with pre-call and post-call SMS messaging for enhanced engagement
- [Retry Policy of Campaigns](https://docs.interactly.ai/campaigns/retry-policy-of-campaigns.md): A comprehensive guide to understanding, configuring, and optimizing automated retry strategies for your campaigns.
- [Single-Modal Campaign](https://docs.interactly.ai/campaigns/single-modal-campaign.md): Learn how to set up, launch, and manage single-modal campaigns for voice-only automated phone calls with AI assistants
- [Welcome](https://docs.interactly.ai/general/introduction.md): Here you'll find information to get started, as well as a sample API Reference.
- [Support](https://docs.interactly.ai/general/support.md)
- [Client SDK](https://docs.interactly.ai/quickstart/client-SDK.md)
- [Dashboard](https://docs.interactly.ai/quickstart/dashboard.md)
- [ElevenLabs TTS Configuration Guide](https://docs.interactly.ai/vendors/elevenlabs-TTS-recommended-configurations.md): Optimize your ElevenLabs text-to-speech settings for the best performance and quality
- [Models](https://docs.interactly.ai/vendors/models.md): Complete list of supported Large Language Model (LLM) providers with their available models.
- [Transcribers](https://docs.interactly.ai/vendors/transcribers.md): Complete list of supported Speech-to-Text (STT) vendors with their available languages, models, and voices.
- [Voices](https://docs.interactly.ai/vendors/voices.md): Complete list of supported Text-to-Speech (TTS) vendors with their available languages, models, and voices.
- [Conversation Update Event](https://docs.interactly.ai/webhooks/events/conversation-update.md): Real-time conversation transcripts and message notifications
- [End of Call Report Event](https://docs.interactly.ai/webhooks/events/end-of-call-report.md): Comprehensive call summary with analytics and recordings
- [Error Event](https://docs.interactly.ai/webhooks/events/error.md): Notifications for LLM and STT processing errors
- [Hang Event](https://docs.interactly.ai/webhooks/events/hang.md): Notifications when assistant fails to respond within timeout
- [Webhook Events Overview](https://docs.interactly.ai/webhooks/events/introduction.md): Complete guide to Interactly webhook events at the assistant level
- [Status Update Event](https://docs.interactly.ai/webhooks/events/status-update.md): Real-time call status change notifications
- [Live Events Dashboard](https://docs.interactly.ai/webhooks/events/testing/live-events-dashboard.md): Build a real-time webhook events dashboard to capture and visualize live call messages
- [Local Testing with ngrok](https://docs.interactly.ai/webhooks/events/testing/ngrok-setup.md): Set up a local webhook server for testing Interactly events
- [Setting Server URLs](https://docs.interactly.ai/webhooks/server-url/setting-server-urls.md)

## OpenAPI Specs

- [api](https://api-prod.interactly.ai/api-docs/campaigns/api.json)

## Optional

- [Swagger](https://api-prod.interactly.ai/api-docs)
- [OpenAPI](https://api-prod.interactly.ai/api-docs/api.json)