# Interactly API

## Docs

- [API Keys](https://docs-qa.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-qa.interactly.ai/api-reference/assistants/create-assistant.md): To create an assistant.
- [Delete Assistant](https://docs-qa.interactly.ai/api-reference/assistants/delete-assistant.md): Delete Assistant by ID
- [Get Assistant](https://docs-qa.interactly.ai/api-reference/assistants/get-assistant.md): Get Assistant Details by ID
- [List Assistants](https://docs-qa.interactly.ai/api-reference/assistants/list-assistants.md): List Assistants
- [Update Assistant](https://docs-qa.interactly.ai/api-reference/assistants/update-assistant.md): Update Assistant Details by ID
- [Connect Call](https://docs-qa.interactly.ai/api-reference/calls/connect-call.md): Connect your call with Interactly.
- [Control Call](https://docs-qa.interactly.ai/api-reference/calls/control-call.md): This API will allow you to control the call.
- [Create Call](https://docs-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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 And Calls Tags](https://docs-qa.interactly.ai/api-reference/campaigns/campaign-stats/get-campaign-and-calls-tags.md): Get all distinct tags for a specific campaign or across all campaigns and calls. - **campaign_id**: Optional — scope results to a single campaign.
- [Get Campaign Call Stats](https://docs-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.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-qa.interactly.ai/api-reference/campaigns/contacts/get-contacts-stats.md): Fetch statistics about contacts for the team.
- [Update Contact](https://docs-qa.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-qa.interactly.ai/api-reference/files/delete-file.md): Delete File
- [Get File](https://docs-qa.interactly.ai/api-reference/files/get-file.md): Get File
- [List Files](https://docs-qa.interactly.ai/api-reference/files/list-files.md): Lists the files available to upload in a knowledge base.
- [Upload File](https://docs-qa.interactly.ai/api-reference/files/upload-file.md): Upload File
- [Debug](https://docs-qa.interactly.ai/api-reference/integrations/admin/debug.md): Debug endpoint to inspect computed OAuth values.
- [Get Integration Tokens](https://docs-qa.interactly.ai/api-reference/integrations/admin/get-integration-tokens.md)
- [Get Past Analysis](https://docs-qa.interactly.ai/api-reference/integrations/admin/get-past-analysis.md): Return past analysis records and resolved final status for a given run_id + patient_uuid.
- [List Indexes](https://docs-qa.interactly.ai/api-reference/integrations/admin/list-indexes.md): List indexes for integration-related collections.
- [Reset Integrations](https://docs-qa.interactly.ai/api-reference/integrations/admin/reset-integrations.md): Delete the IntegrationTokens document for a team to start fresh.
- [Team Overview](https://docs-qa.interactly.ai/api-reference/integrations/admin/team-overview.md): Return an overview of all integration-related documents for a team (tokens, groups, configs).
- [Login](https://docs-qa.interactly.ai/api-reference/integrations/auth/login.md): Redirect user to Microsoft login; carries teamId, userId and optional UI redirect in state.
- [Get Records](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/get-records.md)
- [Get Status](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/get-status.md): Return the latest cadence run log for the given group from Mongo.
- [Patient Uuid Analysis](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/patient-uuid-analysis.md): Return aggregated analysis of `UseCaseActionLog` grouped by unique patient UUID.
- [Reset](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/reset.md): Delete cadence logs for a given team/assistant/user (destructive).
- [Reset Get](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/reset-get.md)
- [Run Legacy](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/run-legacy.md)
- [Run Now](https://docs-qa.interactly.ai/api-reference/integrations/cadence-public/run-now.md)
- [Run](https://docs-qa.interactly.ai/api-reference/integrations/cadence-run/run.md)
- [Reset Integrations](https://docs-qa.interactly.ai/api-reference/integrations/integrations-admin/reset-integrations.md): Dangerous dev-only endpoint: remove ALL integration token documents (optionally all related use-case docs).
- [Export Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-io-v2/export-integration.md)
- [Import Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-io-v2/import-integration.md): Import a full integration (integration + resource records + use cases) into the requester's team.
- [Create Resource Record](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/create-resource-record.md)
- [Create Resource Records Bulk](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/create-resource-records-bulk.md)
- [Delete Resource Record](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/delete-resource-record.md)
- [Get Appointments Dashboard](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/get-appointments-dashboard.md)
- [Get Patients Dashboard](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/get-patients-dashboard.md)
- [Get Resource Record](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/get-resource-record.md)
- [Get Resource Record](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/get-resource-record-1.md)
- [Get Resource Records Schema](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/get-resource-records-schema.md)
- [List Resource Records](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/list-resource-records.md)
- [Sync Integration Resource Records Data](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/sync-integration-resource-records-data.md)
- [Update Resource Record](https://docs-qa.interactly.ai/api-reference/integrations/integrations-resource-records-v2/update-resource-record.md)
- [Assistant Integrations](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/assistant-integrations.md): Return all integration use-cases configured for a given assistant within the requester's team.
- [Create Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/create-integration.md)
- [Delete Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/delete-integration.md)
- [Get Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/get-integration.md)
- [Get Use Cases Schema](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/get-use-cases-schema.md)
- [List Integrations](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/list-integrations.md)
- [Update Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-use-cases-v2/update-integration.md)
- [Create Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/create-integration.md)
- [Delete Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/delete-integration.md)
- [Get Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/get-integration.md)
- [Get Integrations Schema](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/get-integrations-schema.md)
- [List Integrations](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/list-integrations.md)
- [Oauth Authorize](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/oauth-authorize.md)
- [Update Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations-v2/update-integration.md)
- [Delete Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations/delete-integration.md)
- [Disconnect Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations/disconnect-integration.md)
- [Get Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations/get-integration.md)
- [List Integrations Alias](https://docs-qa.interactly.ai/api-reference/integrations/integrations/list-integrations-alias.md): Return integrations that have connectedAt set (i.e., connection was established at some point).
- [Reconnect Integration](https://docs-qa.interactly.ai/api-reference/integrations/integrations/reconnect-integration.md): Reconnect an integration: sets isActive=True and updates tokens, keeps connectedAt unchanged. Errors if integration is not already connected.
- [Delete Use Case Group](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/delete-use-case-group.md)
- [Get Use Case Group](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/get-use-case-group.md)
- [Get Use Case Schema](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/get-use-case-schema.md): Return JSON schemas plus defaults & example payload for a specific use case.
- [List Use Case Groups](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/list-use-case-groups.md)
- [List Use Cases](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/list-use-cases.md): Return the static catalog of available use cases including defaults and examples.
- [Upsert Group And Usecases](https://docs-qa.interactly.ai/api-reference/integrations/use-cases/upsert-group-and-usecases.md): Create or update a UseCaseGroup and REPLACE its use-case configs with the provided list in one call.
- [Verify Live Sheet](https://docs-qa.interactly.ai/api-reference/integrations/verify-sheets/verify-live-sheet.md)
- [Create Knowledge Base](https://docs-qa.interactly.ai/api-reference/knowledge-bases/create-knowledge-base.md): Create Knowledge Base
- [Delete Knowledge Base](https://docs-qa.interactly.ai/api-reference/knowledge-bases/delete-knowledge-base.md): Delete Knowledge Base
- [Fetch the FAQ template for a knowledge base](https://docs-qa.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-qa.interactly.ai/api-reference/knowledge-bases/get-knowledge-base.md): Get Knowledge Base
- [Get Knowledge Base Status](https://docs-qa.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-qa.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-qa.interactly.ai/api-reference/knowledge-bases/list-knowledge-bases.md): List Knowledge Bases
- [Query Knowledge Base](https://docs-qa.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-qa.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-qa.interactly.ai/api-reference/knowledge-bases/train-knowledge-base.md): Send a trigger to train the knowledge base again
- [Update Knowledge Base](https://docs-qa.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-qa.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-qa.interactly.ai/api-reference/phone-numbers/delete-number.md): Deletes a number by its ID.
- [Import Number](https://docs-qa.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-qa.interactly.ai/api-reference/phone-numbers/list-numbers.md): Get list of Numbers purchased
- [List Purchasable Numbers](https://docs-qa.interactly.ai/api-reference/phone-numbers/list-purchasable-numbers.md): Retrieves a list of numbers available for purchase.
- [Purchase Number](https://docs-qa.interactly.ai/api-reference/phone-numbers/purchase-number.md): Purchases a number.
- [Update Number](https://docs-qa.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 Prompt](https://docs-qa.interactly.ai/api-reference/prompts/prompts/create-prompt.md): Endpoint to create a new prompt.
- [Delete Prompt By Id](https://docs-qa.interactly.ai/api-reference/prompts/prompts/delete-prompt-by-id.md): Endpoint to delete a specific prompt.
- [Generate Prompt](https://docs-qa.interactly.ai/api-reference/prompts/prompts/generate-prompt.md): Endpoint to geterate a new prompt prompt given context.
- [Get Prompt By Id](https://docs-qa.interactly.ai/api-reference/prompts/prompts/get-prompt-by-id.md): Endpoint to retrieve a specific prompt by ID.
- [List Prompts](https://docs-qa.interactly.ai/api-reference/prompts/prompts/list-prompts.md): Endpoint to retrieve prompts for a specific team with optional pagination and search.
- [Update Prompt](https://docs-qa.interactly.ai/api-reference/prompts/prompts/update-prompt.md): Endpoint to update a specific prompt.
- [Create Tool](https://docs-qa.interactly.ai/api-reference/tools/create-tool.md)
- [Delete Tool](https://docs-qa.interactly.ai/api-reference/tools/delete-tool.md)
- [Get Tool](https://docs-qa.interactly.ai/api-reference/tools/get-tool.md)
- [List Tools](https://docs-qa.interactly.ai/api-reference/tools/list-tools.md)
- [Update Tool](https://docs-qa.interactly.ai/api-reference/tools/update-tool.md)
- [Server Message](https://docs-qa.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.
- [Create Edge](https://docs-qa.interactly.ai/api-reference/workflows/edges/create-edge.md): Endpoint to create a new edge.
- [Delete Edge](https://docs-qa.interactly.ai/api-reference/workflows/edges/delete-edge.md): Endpoint to delete an edge by its ID. Optionally verify the edge belongs to a specific version number before deleting.
- [Get Edge](https://docs-qa.interactly.ai/api-reference/workflows/edges/get-edge.md): Endpoint to retrieve an edge configuration by its ID. Optionally verify the edge belongs to a specific version.
- [Get Edge Schema](https://docs-qa.interactly.ai/api-reference/workflows/edges/get-edge-schema.md): Endpoint to retrieve the schema for a specific edge type.
- [Get Edge Types](https://docs-qa.interactly.ai/api-reference/workflows/edges/get-edge-types.md): Endpoint to retrieve the available edge types.
- [Get Edges](https://docs-qa.interactly.ai/api-reference/workflows/edges/get-edges.md): Endpoint to retrieve all edges. If version_number is not provided but workflow_id is, defaults to the workflow's active_version_number.
- [Update Edge](https://docs-qa.interactly.ai/api-reference/workflows/edges/update-edge.md): Endpoint to update a edge by its ID. Optionally verify the edge belongs to a specific version number before updating.
- [Bulk Create Global Variables Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/bulk-create-global-variables-endpoint.md): Bulk create/upsert global variables for the team.
- [Create Global Variable Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/create-global-variable-endpoint.md): Create a new global variable for the team.
- [Delete Global Variable Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/delete-global-variable-endpoint.md): Delete a global variable.
- [Get Global Variable Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/get-global-variable-endpoint.md): Get a single global variable by ID (full value, including secrets for editing).
- [List Global Variables Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/list-global-variables-endpoint.md): List all global variables for the team. Secret values are masked.
- [Resolve Global Variables Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/resolve-global-variables-endpoint.md): Resolve all global variables for the team into a {name: value} dict. Used by execution services.
- [Update Global Variable Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/global-variables/update-global-variable-endpoint.md): Update a global variable.
- [Create Node Library](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/create-node-library.md): Endpoint to create a new node library.
- [Delete Node Library](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/delete-node-library.md): Endpoint to delete a node library by its ID.
- [Get Node Libraries](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/get-node-libraries.md): Endpoint to retrieve all node libraries.
- [Get Node Library](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/get-node-library.md): Endpoint to retrieve a node library configuration by its ID.
- [Get Node Library Schema](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/get-node-library-schema.md): Endpoint to retrieve the schema for node libraries.
- [Update Node Library](https://docs-qa.interactly.ai/api-reference/workflows/node-libraries/update-node-library.md): Endpoint to update a Node library by its ID.
- [Create Node](https://docs-qa.interactly.ai/api-reference/workflows/nodes/create-node.md): Endpoint to create a new node.
- [Delete Node](https://docs-qa.interactly.ai/api-reference/workflows/nodes/delete-node.md): Endpoint to delete a node by its ID.
- [Get Node](https://docs-qa.interactly.ai/api-reference/workflows/nodes/get-node.md): Endpoint to retrieve a node configuration by its ID. Optionally verify the node belongs to a specific version number.
- [Get Node Schema](https://docs-qa.interactly.ai/api-reference/workflows/nodes/get-node-schema.md): Endpoint to retrieve the schema for a specific node type.
- [Get Node Types](https://docs-qa.interactly.ai/api-reference/workflows/nodes/get-node-types.md): Endpoint to retrieve the available node types.
- [Get Nodes](https://docs-qa.interactly.ai/api-reference/workflows/nodes/get-nodes.md): Endpoint to retrieve all nodes. If version_number is not provided but workflow_id is, defaults to the workflow's active_version_number.
- [Update Node](https://docs-qa.interactly.ai/api-reference/workflows/nodes/update-node.md): Endpoint to update a node by its ID. Optionally verify the node belongs to a specific version number before updating.
- [Create Simulation](https://docs-qa.interactly.ai/api-reference/workflows/simulations/create-simulation.md): Endpoint to create a new simulation.
- [Delete Simulation](https://docs-qa.interactly.ai/api-reference/workflows/simulations/delete-simulation.md): Endpoint to delete a simulation by its ID.
- [Get Detailed Individual Runs For Group](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-detailed-individual-runs-for-group.md): List individual executions within a simulation group with hydrated workflow run details.
- [Get Individual Runs For Group](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-individual-runs-for-group.md): List individual executions (runs) within a simulation group.
- [Get Simulation](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulation.md): Endpoint to retrieve a simulation by its ID.
- [Get Simulation Evaluation Summary Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulation-evaluation-summary-endpoint.md): Get aggregated evaluation results for a simulation across all runs.
- [Get Simulation Run Details](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulation-run-details.md): Get details of a specific simulation group run.
- [Get Simulation Runs](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulation-runs.md): List all run groups for a simulation configuration.
- [Get Simulation Schema](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulation-schema.md): Endpoint to retrieve the schema for simulations.
- [Get Simulations](https://docs-qa.interactly.ai/api-reference/workflows/simulations/get-simulations.md): Endpoint to retrieve all simulations.
- [Run Simulation](https://docs-qa.interactly.ai/api-reference/workflows/simulations/run-simulation.md): Trigger a new simulation batch run from a configuration.
- [Stop Simulation Run](https://docs-qa.interactly.ai/api-reference/workflows/simulations/stop-simulation-run.md): Stop/Cancel a simulation group run.
- [Update Simulation](https://docs-qa.interactly.ai/api-reference/workflows/simulations/update-simulation.md): Endpoint to update a simulation by its ID.
- [Expand Preview](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/expand-preview.md): Server-side super-node expansion for canvas previewing.
- [Get Super Node Dependents](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/get-super-node-dependents.md): Paginated list of workflows that embed the given workflow as a super node.
- [Get Super Node Interface](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/get-super-node-interface.md): Return the full super node definition for a workflow version.
- [Get Super Node Schema](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/get-super-node-schema.md): Return the JSON Schema for the super node's input fields.
- [Get Super Node Snapshot Status](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/get-super-node-snapshot-status.md): Report whether each SuperNodeConfig inside the requested workflow version still matches the latest active publish of its sub-workflow.
- [List Super Nodes](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/list-super-nodes.md): List all super nodes published for this team.
- [Publish As Super Node](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/publish-as-super-node.md): Publish a workflow version as a reusable super node by defining its interface.
- [Unpublish Super Node](https://docs-qa.interactly.ai/api-reference/workflows/super-nodes/unpublish-super-node.md): Unpublish a workflow version as a super node.
- [Create Tool](https://docs-qa.interactly.ai/api-reference/workflows/tools/create-tool.md): Endpoint to create a new tool.
- [Delete Tool](https://docs-qa.interactly.ai/api-reference/workflows/tools/delete-tool.md): Endpoint to delete a tool by its ID. Only custom tools can be deleted; inbuilt tools cannot be deleted.
- [Get Configurable Inbuilt Tool Schema](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-configurable-inbuilt-tool-schema.md): Return the extra-config JSON schema for a single configurable inbuilt tool.
- [Get Configurable Inbuilt Tools](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-configurable-inbuilt-tools.md): List all configurable inbuilt tools from the catalogue.
- [Get Inbuilt Tools](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-inbuilt-tools.md): Endpoint to retrieve all inbuilt tools from the registry. This is a helper endpoint for debugging and understanding available inbuilt tools.
- [Get Tool](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-tool.md): Endpoint to retrieve a tool configuration by its ID. Checks both custom tools in the database and inbuilt tools from the registry.
- [Get Tool Schema](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-tool-schema.md): Endpoint to retrieve the schema for a specific tool type.
- [Get Tool Types](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-tool-types.md): Endpoint to retrieve the available tool types.
- [Get Tools](https://docs-qa.interactly.ai/api-reference/workflows/tools/get-tools.md): Endpoint to retrieve all tools including custom tools and inbuilt tools.
- [Update Tool](https://docs-qa.interactly.ai/api-reference/workflows/tools/update-tool.md)
- [Get Workflow Categories](https://docs-qa.interactly.ai/api-reference/workflows/workflow-categories/get-workflow-categories.md): Retrieve all available workflow categories for the current team. Returns merged global defaults + team-specific custom categories, deduplicated.
- [Execute Checkpoint Run](https://docs-qa.interactly.ai/api-reference/workflows/workflow-execution/execute-checkpoint-run.md): Trigger a new workflow run from a checkpoint of an existing workflow run.
- [Execute Workflow](https://docs-qa.interactly.ai/api-reference/workflows/workflow-execution/execute-workflow.md): Execute a workflow interactively over standard HTTP POST.
- [Add Comment To Workflow Run](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/add-comment-to-workflow-run.md): Endpoint to add a comment to a workflow run.
- [Add Comment To Workflow Run Event](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/add-comment-to-workflow-run-event.md): Endpoint to add a comment to a workflow run.
- [Delete Workflow Run](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/delete-workflow-run.md): Endpoint to delete a workflow run by its ID.
- [Delete Workflow Run Comment](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/delete-workflow-run-comment.md): Endpoint to delete a comment from a workflow run.
- [Delete Workflow Run Event Comment](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/delete-workflow-run-event-comment.md): Endpoint to delete a comment from a specific event in a workflow run.
- [Get Workflow Run](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/get-workflow-run.md): Endpoint to retrieve a workflow run by its ID.
- [Get Workflow Run Evaluation Result](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/get-workflow-run-evaluation-result.md): Endpoint to retrieve the evaluation result for a workflow run.
- [Get Workflow Run Schema](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/get-workflow-run-schema.md): Endpoint to retrieve the schema for a workflow run.
- [Get Workflow Runs](https://docs-qa.interactly.ai/api-reference/workflows/workflow-runs/get-workflow-runs.md): Endpoint to retrieve workflow runs for a specific workflow if workflow_id is provided. Else, all workflow runs for the team are retrieved.
- [Cancel Workflow Schedule](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/cancel-workflow-schedule.md): Cancel a pending scheduled run.
- [Create Workflow Schedule](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/create-workflow-schedule.md): Schedule a workflow to run at a future time.
- [Get Workflow Schedule](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/get-workflow-schedule.md): Get a single scheduled run by ID.
- [List Team Workflow Schedules](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/list-team-workflow-schedules.md): List all scheduled runs for the entire team.
- [List Workflow Schedules](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/list-workflow-schedules.md): List scheduled runs for a workflow.
- [Update Workflow Schedule](https://docs-qa.interactly.ai/api-reference/workflows/workflow-schedules/update-workflow-schedule.md): Modify a pending scheduled run (time, inputs, or version).
- [Create Workflow Template](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/create-workflow-template.md): Endpoint to create a new workflow template.
- [Delete Workflow Template](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/delete-workflow-template.md): Endpoint to delete a workflow template by its ID.
- [Get Workflow Template](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/get-workflow-template.md): Endpoint to retrieve a workflow template by its ID.
- [Get Workflow Template Schema](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/get-workflow-template-schema.md): Endpoint to retrieve the schema for workflow templates.
- [Get Workflow Templates](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/get-workflow-templates.md): Endpoint to retrieve all workflow templates.
- [Update Workflow Template](https://docs-qa.interactly.ai/api-reference/workflows/workflow-templates/update-workflow-template.md): Endpoint to update a Workflow template by its ID.
- [Compare Workflow Versions](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/compare-workflow-versions.md): Compare two workflow versions and return a detailed diff.
- [Create Workflow Version](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/create-workflow-version.md)
- [Delete Workflow Version](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/delete-workflow-version.md)
- [List Workflow Versions](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/list-workflow-versions.md)
- [Set Active Workflow Version](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/set-active-workflow-version.md): Sets a specific version as the active version for the workflow. The frontend/runner will use this version by default.
- [Update Workflow Version Config](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/update-workflow-version-config.md): Update a specific version's workflow_config. This allows editing workflow settings (name, description, global LLM config, etc.) for a specific version.
- [Update Workflow Version Name](https://docs-qa.interactly.ai/api-reference/workflows/workflow-versions/update-workflow-version-name.md)
- [Create Workflow Webhook](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/create-workflow-webhook.md)
- [Delete Workflow Webhook](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/delete-workflow-webhook.md)
- [List Workflow Webhook Attempts](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/list-workflow-webhook-attempts.md)
- [List Workflow Webhook Events](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/list-workflow-webhook-events.md)
- [List Workflow Webhooks](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/list-workflow-webhooks.md)
- [Retry Workflow Webhook Event](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/retry-workflow-webhook-event.md)
- [Update Workflow Webhook](https://docs-qa.interactly.ai/api-reference/workflows/workflow-webhooks/update-workflow-webhook.md)
- [Clone Workflow Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/workflows/clone-workflow-endpoint.md): Endpoint to clone a workflow, optionally including specific versions.
- [Create Workflow](https://docs-qa.interactly.ai/api-reference/workflows/workflows/create-workflow.md): Endpoint to create a new workflow. If a WorkflowConfigFullyHydrated is provided, creates the workflow and all its nodes/edges atomically. Otherwise, creates an initial version of the workflow with version number 0.
- [Delete Workflow](https://docs-qa.interactly.ai/api-reference/workflows/workflows/delete-workflow.md): Endpoint to delete a workflow by its ID.
- [Export Workflow Bundle](https://docs-qa.interactly.ai/api-reference/workflows/workflows/export-workflow-bundle.md)
- [Get Global Node Config Schema](https://docs-qa.interactly.ai/api-reference/workflows/workflows/get-global-node-config-schema.md): Endpoint to retrieve the JSON schema for ``GlobalNodeConfig``.
- [Get Workflow](https://docs-qa.interactly.ai/api-reference/workflows/workflows/get-workflow.md): Endpoint to retrieve a workflow configuration by its ID.
- [Get Workflow Dynamic Variables](https://docs-qa.interactly.ai/api-reference/workflows/workflows/get-workflow-dynamic-variables.md): Endpoint to retrieve a workflow's dynamic variables by its ID.
- [Get Workflow Schema](https://docs-qa.interactly.ai/api-reference/workflows/workflows/get-workflow-schema.md): Endpoint to retrieve the schema for workflow
- [Get Workflows](https://docs-qa.interactly.ai/api-reference/workflows/workflows/get-workflows.md): Endpoint to retrieve all workflows.
- [Import Workflow Bundle Endpoint](https://docs-qa.interactly.ai/api-reference/workflows/workflows/import-workflow-bundle-endpoint.md)
- [Update Workflow](https://docs-qa.interactly.ai/api-reference/workflows/workflows/update-workflow.md): Update a workflow's configuration. Behavior: - If version_number is provided: Updates the specific WorkflowVersionModel (for versioned workflows)   or falls back to parent WorkflowsModel (for legacy workflows without version models) - If version_number is NOT provided: Updates parent WorkflowsModel…
- [Update Workflow Concurrency](https://docs-qa.interactly.ai/api-reference/workflows/workflows/update-workflow-concurrency.md): Update the per-workflow concurrency limit.
- [Assistant Tools](https://docs-qa.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-qa.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-qa.interactly.ai/calls/call-features.md)
- [DND & Callback](https://docs-qa.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-qa.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-qa.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-qa.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-qa.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-qa.interactly.ai/general/introduction.md): Here you'll find information to get started, as well as a sample API Reference.
- [Support](https://docs-qa.interactly.ai/general/support.md)
- [Client SDK](https://docs-qa.interactly.ai/quickstart/client-SDK.md)
- [Dashboard](https://docs-qa.interactly.ai/quickstart/dashboard.md)
- [ElevenLabs TTS Configuration Guide](https://docs-qa.interactly.ai/vendors/elevenlabs-TTS-recommended-configurations.md): Optimize your ElevenLabs text-to-speech settings for the best performance and quality
- [Models](https://docs-qa.interactly.ai/vendors/models.md): Complete list of supported Large Language Model (LLM) providers with their available models.
- [Transcribers](https://docs-qa.interactly.ai/vendors/transcribers.md): Complete list of supported Speech-to-Text (STT) vendors with their available languages, models, and voices.
- [Voices](https://docs-qa.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-qa.interactly.ai/webhooks/events/conversation-update.md): Real-time conversation transcripts and message notifications
- [End of Call Report Event](https://docs-qa.interactly.ai/webhooks/events/end-of-call-report.md): Comprehensive call summary with analytics and recordings
- [Error Event](https://docs-qa.interactly.ai/webhooks/events/error.md): Notifications for LLM and STT processing errors
- [Hang Event](https://docs-qa.interactly.ai/webhooks/events/hang.md): Notifications when assistant fails to respond within timeout
- [Webhook Events Overview](https://docs-qa.interactly.ai/webhooks/events/introduction.md): Complete guide to Interactly webhook events at the assistant level
- [Status Update Event](https://docs-qa.interactly.ai/webhooks/events/status-update.md): Real-time call status change notifications
- [Live Events Dashboard](https://docs-qa.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-qa.interactly.ai/webhooks/events/testing/ngrok-setup.md): Set up a local webhook server for testing Interactly events
- [Building a Workflow](https://docs-qa.interactly.ai/workflows/building-a-workflow.md): Learn how to build a workflow from scratch — adding nodes, connecting edges, attaching tools, setting global variables, and publishing a version for live execution
- [Workflows](https://docs-qa.interactly.ai/workflows/introduction.md): Learn about Interactly's workflow system — how to build, version, simulate, and execute agentic workflows powered by LLMs, tools, and configurable node graphs
- [Node Types](https://docs-qa.interactly.ai/workflows/node-types.md): Explore every node type available in Interactly workflows — LLM nodes, tool and HTTP nodes, communication nodes, and workflow control nodes — with configuration details and use cases
- [Scheduled & Triggered Workflows](https://docs-qa.interactly.ai/workflows/scheduled-and-triggered-workflows.md): Learn how to run workflows automatically using a scheduled datetime trigger or event-driven SQS and inbound webhook triggers, with concurrency and execution controls
- [Tools & Integrations](https://docs-qa.interactly.ai/workflows/tools-and-integrations.md): Learn how to register and attach tools to workflow nodes — inbuilt functions, inline Python, external REST APIs, and Knowledge Base queries — and configure LLM provider integrations
- [Workflow Simulation](https://docs-qa.interactly.ai/workflows/workflow-simulation.md): Learn how to use Interactly's workflow simulation feature to run two workflows in parallel, compare their outputs, and evaluate performance before activating a version for live traffic
- [Workflow Versioning](https://docs-qa.interactly.ai/workflows/workflow-versioning.md): Learn how Interactly's workflow versioning system works — creating versions, activating them for live use, comparing changes, importing and exporting, and rolling back when needed
- [Workflow Webhooks](https://docs-qa.interactly.ai/workflows/workflow-webhooks.md): Learn how to configure outbound webhooks for workflow lifecycle events — workflow created, updated, deleted, run started, and run completed — with payload examples and retry behaviour

## OpenAPI Specs

- [api](https://api-qa.interactly.ai/api-docs/workflows/api.json)

## Optional

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