# Cognigy Documentation: Cognigy API ## Cognigy API ### Overview - [Cognigy API](https://docs.cognigy.com/api-reference/index.md) - [About Cognigy API](https://docs.cognigy.com/api-reference/about.md): Introduction to the Cognigy REST API, covering authentication, CORS support, and RESTful endpoints for managing AI Agents and platform resources. ### Core Resources #### Administration - [Get Knowledge Chunk Count](https://docs.cognigy.com/api-reference/administration/get-knowledge-chunk-count.md): Gets the total number of Knowledge Chunks created across Projects in the organization. - [Get Organization Policies](https://docs.cognigy.com/api-reference/administration/get-organization-policies.md): Gets all policies for the organization as shown in the Management UI, including quotas, password and session rules, conversation and Contact Profile settings, data privacy options, billing time zone, and AI Ops Center status. - [Initiate Organization Deletion](https://docs.cognigy.com/api-reference/administration/initiate-organization-deletion.md): Initiates the process to delete an organisation. A confirmation token will be sent via email to the system administrator to proceed with the deletion. - [Get the License State for the Organization](https://docs.cognigy.com/api-reference/administration/get-the-license-state-for-the-organization.md): Gets the current license state of the organization, including its system capabilities and usage quotas. - [Set the License](https://docs.cognigy.com/api-reference/administration/set-the-license.md): Sets the system license for the organization, updating license details such as access and quotas. - [Get System Maintenance Messages](https://docs.cognigy.com/api-reference/administration/get-system-maintenance-messages.md): Gets system-wide maintenance messages that are preconfigured in the Management UI, including their display timing and visibility settings. #### Agent Copilot Configurations - [Get Agent Copilot Configurations](https://docs.cognigy.com/api-reference/agent-copilot-configurations/get-agent-copilot-configurations.md): Gets Agent Copilot configurations for a Project. By default, 25 audit events are returned. Use the `limit` query parameter to change this value. - [Get an Agent Copilot Configuration](https://docs.cognigy.com/api-reference/agent-copilot-configurations/get-an-agent-copilot-configuration.md): Gets an Agent Copilot Configuration from a Project. - [Update an Agent Copilot Configuration](https://docs.cognigy.com/api-reference/agent-copilot-configurations/update-an-agent-copilot-configuration.md): Updates an existing Agent Copilot configuration in a Project. Allows modifying the grid layout, tiles, or metadata of a configuration. You must provide the relevant project ID and the configuration ID to apply changes. #### Agent Copilot Configuration - [Create an Agent Copilot Configuration](https://docs.cognigy.com/api-reference/agent-copilot-configuration/create-an-agent-copilot-configuration.md): Creates an Agent Copilot configuration in a Project. The Agent Copilot configuration defines the grid layout, which serves as the structure for your AI Copilot Workspace. After creation, select the configuration in the Cognigy.AI Endpoint under the Copilot section. - [Delete an Agent Copilot Configuration](https://docs.cognigy.com/api-reference/agent-copilot-configuration/delete-an-agent-copilot-configuration.md): Deletes an Agent Copilot configuration from a Project. If the configuration is still in use in the Copilot section of any Endpoint in this Project, replace the configuration with another one before using this method. #### AI Agents - [Get AI Agents](https://docs.cognigy.com/api-reference/ai-agents/get-ai-agents.md): Gets AI Agents from a Project. By default, returns 25 AI Agents from all Projects the user has access to. Use the `limit` query parameter to change the default value. Specify the Project ID to get AI Agents from a specific Project. - [Create an AI Agent](https://docs.cognigy.com/api-reference/ai-agents/create-an-ai-agent.md): Creates an AI Agent in a Project. The request defines the AI Agent persona (name, description, avatar), behavioral instructions, speaking style, and safety settings. You can optionally link the AI Agent to a Knowledge Store, configure voice and text-to-speech settings, and control whether voice conf… - [Get an AI Agent](https://docs.cognigy.com/api-reference/ai-agents/get-an-ai-agent.md): Gets an AI Agent from a Project. Returns the AI Agent configuration, including identity, description, avatar, instructions, speaking style, voice, safety settings, and metadata such as creation and modification timestamps. - [Delete an AI Agent](https://docs.cognigy.com/api-reference/ai-agents/delete-an-ai-agent.md): Deletes an AI Agent from a Project. - [Update an AI Agent](https://docs.cognigy.com/api-reference/ai-agents/update-an-ai-agent.md): Updates an AI Agent in a Project. Allows modifying AI Agent persona, instructions, speaking style, voice, and safety settings. Returns no content on success - [Get AI Agent Jobs and their Tools](https://docs.cognigy.com/api-reference/ai-agents/get-ai-agent-jobs-and-their-tools.md): Gets all jobs and associated tools for an AI Agent by its ID. - [Hire an AI Agent from the Job Market](https://docs.cognigy.com/api-reference/ai-agents/hire-an-ai-agent-from-the-job-market.md): Hires an AI Agent in a Project using a ready-made template (`templateId`) with predefined skills for a specific job. You can optionally override an existing AI Agent using `overrideAiAgentReferenceId` to adapt it to your needs. The method returns a task tracking the status of the hiring process. - [Get AI Agents from the Job Market](https://docs.cognigy.com/api-reference/ai-agents/get-ai-agents-from-the-job-market.md): Gets a list of AI Agents from the job market that are ready for hire. - [Test an A2A agent connection](https://docs.cognigy.com/api-reference/ai-agents/test-an-a2a-agent-connection.md): Validates connectivity and authentication to an A2A agent's base URL by fetching its agent card, without saving or executing anything. Project-scoped rather than AI-Agent-scoped, since an A2A Agent node can also live in an ordinary Flow with no AI Agent resource behind it. - [Check AI Agent Name Availability](https://docs.cognigy.com/api-reference/ai-agents/check-ai-agent-name-availability.md): Checks whether an AI Agent name is already used in a Project. #### Alexa - [Deploy an Alexa Endpoint to an Alexa Skill](https://docs.cognigy.com/api-reference/alexa/deploy-an-alexa-endpoint-to-an-alexa-skill.md): Deploys a Cognigy.AI Alexa Endpoint to an Alexa skill. - [Get Alexa Skills](https://docs.cognigy.com/api-reference/alexa/get-alexa-skills.md): Gets a list of all Alexa skills associated with the current user, including details like skill ID, name per locale, last update, and lifecycle stage. - [Create an Amazon User](https://docs.cognigy.com/api-reference/alexa/create-an-amazon-user.md): Creates an authenticated Amazon user by submitting their access token and refresh token. This method enables secure integration with Amazon Alexa services for the current Cognigy.AI user. - [Get Amazon User Details](https://docs.cognigy.com/api-reference/alexa/get-amazon-user-details.md): Gets details about an already registered Amazon user. - [Delete an Amazon User](https://docs.cognigy.com/api-reference/alexa/delete-an-amazon-user.md): Deletes an already registered Amazon user from the Cognigy.AI platform. #### Analytics - [Update an Analytics Record](https://docs.cognigy.com/api-reference/analytics/update-an-analytics-record.md): Updates an analytics record for a specific user input. Allows modifying conversation properties, Flow and Intent details, ratings, handover information, Slots, tracked goals, and custom fields. - [Delete Analytics Records](https://docs.cognigy.com/api-reference/analytics/delete-analytics-records.md): Deletes analytics records for a Project. - [Get Call Counter Metrics for the Organization](https://docs.cognigy.com/api-reference/analytics/get-call-counter-metrics-for-the-organization.md): Gets call counter metrics for the organization. - [Get Conversation Counter Metrics for the Organization](https://docs.cognigy.com/api-reference/analytics/get-conversation-counter-metrics-for-the-organization.md): Gets conversation counter metrics for the organization. - [Get Knowledge Query Counter Metrics for an Organization.](https://docs.cognigy.com/api-reference/analytics/get-knowledge-query-counter-metrics-for-an-organization.md): Gets knowledge query counter metrics for the organization. - [Get Call Counter Metrics for a Project](https://docs.cognigy.com/api-reference/analytics/get-call-counter-metrics-for-a-project.md): Gets call counter metrics for a Project by its ID. - [Get Conversation Counter Metrics for a Project](https://docs.cognigy.com/api-reference/analytics/get-conversation-counter-metrics-for-a-project.md): Gets conversation counter metrics for a Project by its ID. - [Get Knowledge Query Counter Metrics for a Project.](https://docs.cognigy.com/api-reference/analytics/get-knowledge-query-counter-metrics-for-a-project.md): Gets knowledge query counter metrics for a Project by its ID. #### Analytics 3.0 - [Get Call Counter Metrics for the Organization](https://docs.cognigy.com/api-reference/analytics-30/get-call-counter-metrics-for-the-organization.md): Gets call counter metrics for the organization. Data is available up to two days ago, and only for 2025 onwards. - [Get Conversation Counter Metrics for the Organization](https://docs.cognigy.com/api-reference/analytics-30/get-conversation-counter-metrics-for-the-organization.md): Gets conversation counter metrics for the organization. Data is available up to one day ago, and only for 2025 onwards. - [Get Call Counter Metrics for a Project](https://docs.cognigy.com/api-reference/analytics-30/get-call-counter-metrics-for-a-project.md): Gets call counter metrics for a Project by its ID. Data is available up to two days ago, and only for 2025 onwards. - [Get Conversation Counter Metrics for a Project](https://docs.cognigy.com/api-reference/analytics-30/get-conversation-counter-metrics-for-a-project.md): Gets conversation counter metrics for a Project by its ID. Data is available up to one day ago, and only for 2025 onwards. #### Audit Events - [Get Audit Events](https://docs.cognigy.com/api-reference/audit-events/get-audit-events.md): Gets audit events for the organization. By default, 25 audit events are returned. Use the `limit` query parameter to change this value. - [Get an Audit Event](https://docs.cognigy.com/api-reference/audit-events/get-an-audit-event.md): Gets an audit event by its ID. #### Connections - [Get Connections](https://docs.cognigy.com/api-reference/connections/get-connections.md): Gets Connections from a Project. By default, 25 Connections are returned. To change this value, use the `limit` query parameter. - [Create a Connection](https://docs.cognigy.com/api-reference/connections/create-a-connection.md): Creates a Connection in a Project. - [Perform Batch Operations on Connections](https://docs.cognigy.com/api-reference/connections/perform-batch-operations-on-connections.md): Performs batch operations on Connections. Executes batch create, update, and delete operations, returning the affected Connection IDs. - [Get a Connection](https://docs.cognigy.com/api-reference/connections/get-a-connection.md): Gets a Connection from a Project. - [Delete a Connection](https://docs.cognigy.com/api-reference/connections/delete-a-connection.md): Deletes a Connection from a Project. Deleting a Connection stops any dependent features from working. Flows that use the deleted Connection aren't updated automatically and may hang at the affected Node, causing errors. - [Update a Connection](https://docs.cognigy.com/api-reference/connections/update-a-connection.md): Updates a Connection in a Project, including type, credential and custom fields. - [Create a Connection Field](https://docs.cognigy.com/api-reference/connections/create-a-connection-field.md): Creates a Connection field, allowing you to store additional key-value data in a Connection. This method is useful for adding custom settings required by external services or integrations. - [Delete a Connection Field](https://docs.cognigy.com/api-reference/connections/delete-a-connection-field.md): Deletes a Connection field, removing the associated key-value data from a Connection. This method is useful for removing unused or sensitive data from a Connection. - [Get Connection Schemas](https://docs.cognigy.com/api-reference/connections/get-connection-schemas.md): Gets Connection schemas from a Project. This method helps understand the structure and fields for creating or validating Connections. By default, 25 schemas are returned. Use the `limit` query parameter to change this value. #### Contact Profiles - [Get Contact Profiles](https://docs.cognigy.com/api-reference/contact-profiles/get-contact-profiles.md): Gets [Contact Profiles](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) in a Project. By default, 25 Contact Profiles are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. This endpoint is deprecated, use `/v2.… - [Create a Contact Profile](https://docs.cognigy.com/api-reference/contact-profiles/create-a-contact-profile.md): Creates a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles). - [Get a Contact Profile](https://docs.cognigy.com/api-reference/contact-profiles/get-a-contact-profile.md): Gets the data of a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles). - [Delete a Contact Profile](https://docs.cognigy.com/api-reference/contact-profiles/delete-a-contact-profile.md): Deletes a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles). - [Update a Contact Profile](https://docs.cognigy.com/api-reference/contact-profiles/update-a-contact-profile.md): Updates Contact Profile data. - [Remove the Contact ID](https://docs.cognigy.com/api-reference/contact-profiles/remove-the-contact-id.md): Removes the contact ID from a Contact Profile. - [Export Contact Profile](https://docs.cognigy.com/api-reference/contact-profiles/export-contact-profile.md): Exports Contact Profile data in JSON format. - [Delete Contact Profile Data](https://docs.cognigy.com/api-reference/contact-profiles/delete-contact-profile-data.md): Deletes data associated with a Contact Profile. - [Merge Contact Profiles](https://docs.cognigy.com/api-reference/contact-profiles/merge-contact-profiles.md): Merges a [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) with another one. - [Unmerge Contact Profiles](https://docs.cognigy.com/api-reference/contact-profiles/unmerge-contact-profiles.md): Splits a merged [Contact Profile](https://docs.cognigy.com/ai/agents/analyze/contact-profiles) into two separate ones. - [Get Schema](https://docs.cognigy.com/api-reference/contact-profiles/get-schema.md): Gets the [Contact Profile schema](https://docs.cognigy.com/ai/agents/analyze/contact-profiles#profile-schema). - [Set Schema](https://docs.cognigy.com/api-reference/contact-profiles/set-schema.md): Sets the [Contact Profile schema](https://docs.cognigy.com/ai/agents/analyze/contact-profiles#profile-schema). - [Get Contact Profiles (performance)](https://docs.cognigy.com/api-reference/contact-profiles/get-contact-profiles-performance.md): Faster variant of Get Contact Profiles. Numeric filter values are matched exactly against contact IDs; other values match first name, last name, or email. Alternatively, use the `exactMatch.*` parameters for an exact (indexed) match on a single field — mutually exclusive with `filter`. By default th… #### Conversations - [Get Conversations](https://docs.cognigy.com/api-reference/conversations/get-conversations.md): Gets conversations from a Project. You can also get conversations for a specific user by specifying their contact ID. - [Deletes a Conversation](https://docs.cognigy.com/api-reference/conversations/deletes-a-conversation.md): Deletes a conversation by its `sessionId`. **Deprecated.** Use the Insights API [DELETE /v2.1/conversations/{sessionId}](#delete-/v2.1/conversations/-sessionId-) instead. #### Conversations v2.0 - [Get a Conversation](https://docs.cognigy.com/api-reference/conversations-v20/get-a-conversation.md): Gets a conversation by its `sessionId`. #### Conversations v2.1 - [Deletes conversations records for a sessionId.](https://docs.cognigy.com/api-reference/conversations-v21/deletes-conversations-records-for-a-sessionid.md): Deletes conversations records for a sessionId. #### Copilot Configs - [Get Copilot Configs](https://docs.cognigy.com/api-reference/copilot-configs/get-copilot-configs.md): Gets Copilot configs for a Project. - [Create a Copilot Config](https://docs.cognigy.com/api-reference/copilot-configs/create-a-copilot-config.md): Stores the workspace JSON and returns as soon as it is stored. Building the flows, publishing them and deploying the Endpoint carry on in the background, so the returned config reads as saved but usually not yet published. - [Get a Copilot Config](https://docs.cognigy.com/api-reference/copilot-configs/get-a-copilot-config.md): Gets a single Copilot config by its id. - [Update a Copilot Config](https://docs.cognigy.com/api-reference/copilot-configs/update-a-copilot-config.md): Re-saves a Copilot config. The same operation as creating one, with the id supplied, and asynchronous in the same way. When it was created, by whom, and any completed deploy are preserved - a re-save cannot rewrite them. - [Delete a Copilot Config](https://docs.cognigy.com/api-reference/copilot-configs/delete-a-copilot-config.md): Deletes a Copilot config. A config that was never published is only a document removal; for a published one, the orchestration Flow and the Endpoint it deployed are torn down in the background after this responds. - [Get the Copilot sample transcript](https://docs.cognigy.com/api-reference/copilot-configs/get-the-copilot-sample-transcript.md): The scripted contact a Copilot config is reviewed against, in order - the order is part of the contract, since reaching the last turn is what fires the end-of-contact trigger. Not scoped to a Project, like the widget catalog. - [Get the pre-built Copilot widgets](https://docs.cognigy.com/api-reference/copilot-configs/get-the-pre-built-copilot-widgets.md): The read-only catalog of pre-built widgets, with their default sizes and triggers, plus the default workspace space derived from their heights. Not scoped to a Project - the catalog is the same everywhere, and it has to be readable before any Copilot config exists so a new one can be sized from it. #### CXOne - [List CXOne Knowledge Hubs](https://docs.cognigy.com/api-reference/cxone/list-cxone-knowledge-hubs.md): Lists the CXOne Knowledge Hubs visible to the project's organisation, for populating the "Knowledgehub ID" dropdown on the Retrieve Knowledge node. Only {id, name, status} are returned — never the underlying data-source configuration, which may contain credentials. #### Endpoints - [Send a Message as a User Input](https://docs.cognigy.com/api-reference/endpoints/send-a-message-as-a-user-input.md): Sends a message as a user input in an active conversation, so an AI Agent can process the input and continue the conversation. For example, to follow up after user inactivity or trigger a reply after an external API event. - [Send a Message as an AI Agent Output](https://docs.cognigy.com/api-reference/endpoints/send-a-message-as-an-ai-agent-output.md): Sends a message as an AI Agent Output. It bypasses the Flow's input processing and delivers a message to the user. For example, sending `Your order 12345 has shipped` as a status update. - [Get Endpoints](https://docs.cognigy.com/api-reference/endpoints/get-endpoints.md): Gets Endpoints from a Project. By default, 25 Endpoints are returned. To change this value, use the `limit` query parameter. - [Create an Endpoint](https://docs.cognigy.com/api-reference/endpoints/create-an-endpoint.md): Creates an Endpoint in a Project. - [Perform Batch Operations on Endpoints](https://docs.cognigy.com/api-reference/endpoints/perform-batch-operations-on-endpoints.md): Performs batch operations on Endpoints in a Project. Use this method to create, update, or delete multiple Endpoints in a request by specifying the operation type (`create`, `update`, or `delete`) for each item in the operations array. - [Get an Endpoint](https://docs.cognigy.com/api-reference/endpoints/get-an-endpoint.md): Gets an Endpoint from a Project. - [Delete an Endpoint](https://docs.cognigy.com/api-reference/endpoints/delete-an-endpoint.md): Deletes an Endpoint from a Project. - [Update an Endpoint](https://docs.cognigy.com/api-reference/endpoints/update-an-endpoint.md): Updates Endpoint settings in a Project. Allows modifying the Endpoint's activation status, Transformers, handover, analytics, and privacy options. - [List Endpoint API Keys](https://docs.cognigy.com/api-reference/endpoints/list-endpoint-api-keys.md): Lists all API keys configured on the given Webhook, Generic, REST, or A2A Server Endpoint. The response never contains the SHA-256 hash or the plaintext key — only the masked preview, name, id, and creation timestamp. - [Create an Endpoint API Key](https://docs.cognigy.com/api-reference/endpoints/create-an-endpoint-api-key.md): Generates a new API key for the given Webhook, Generic, REST, or A2A Server Endpoint. Returns the plaintext key in the response body exactly once — the server stores only the SHA-256 hash and a masked preview, and the plaintext is never retrievable again. - [Revoke an Endpoint API Key](https://docs.cognigy.com/api-reference/endpoints/revoke-an-endpoint-api-key.md): Permanently revokes the given API key by hard-deleting it. Any client still using the revoked key will start failing immediately on the next inbound webhook request (subject to cache propagation). - [Get an Endpoint's voice settings](https://docs.cognigy.com/api-reference/endpoints/get-an-endpoints-voice-settings.md): The same object the endpoint read returns under voiceSettings, on its own route so the Speech and Number cards can refresh without re-reading the whole endpoint — after a 409 conflict, or after the user adds a speech credential elsewhere. #### Example Sentences - [Get Example Sentences](https://docs.cognigy.com/api-reference/example-sentences/get-example-sentences.md): Gets [Example Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent. By default, 25 Example Sentences are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create an Example Sentence](https://docs.cognigy.com/api-reference/example-sentences/create-an-example-sentence.md): Creates an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent. - [Perform Batch Operations](https://docs.cognigy.com/api-reference/example-sentences/perform-batch-operations.md): Performs batch operations on [Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) in an Intent. - [Get an Example Sentence](https://docs.cognigy.com/api-reference/example-sentences/get-an-example-sentence.md): Gets an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent. - [Delete an Example Sentence](https://docs.cognigy.com/api-reference/example-sentences/delete-an-example-sentence.md): Deletes an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) from an Intent. - [Update an Example Sentence](https://docs.cognigy.com/api-reference/example-sentences/update-an-example-sentence.md): Updates an [Example Sentence](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent. - [Generate Example Sentences](https://docs.cognigy.com/api-reference/example-sentences/generate-example-sentences.md): Generates [Example Sentences](https://docs.cognigy.com/ai/platform-features/nlu/intents/example-sentences) for an Intent using generative AI. #### Extensions - [Get Extensions](https://docs.cognigy.com/api-reference/extensions/get-extensions.md): Gets Extensions from a Project. By default, 25 Extensions are returned. To change this value, use the `limit` query parameter. - [Get an Extension](https://docs.cognigy.com/api-reference/extensions/get-an-extension.md): Gets an Extension from a Project. - [Delete an Extension](https://docs.cognigy.com/api-reference/extensions/delete-an-extension.md): Deletes an Extension from a Project. - [Update Extension Settings](https://docs.cognigy.com/api-reference/extensions/update-extension-settings.md): Updates Extension settings, such as enabling or disabling trusted code behavior. - [Update an Extension](https://docs.cognigy.com/api-reference/extensions/update-an-extension.md): Updates an existing uploaded Extension in a Project by replacing it with a new version. You can provide the Extension either as a file upload or via a URL. The method creates a Task to process the update, and the response returns the task status and progress so you can track when the replacement is… - [Upload an Extension](https://docs.cognigy.com/api-reference/extensions/upload-an-extension.md): Upload an Extension to a Project. The Extension can be provided as a file or via a URL. The method creates a Task to process the creation, and the response includes the task status and progress so you can track completion. This upload always creates a new Extension and doesn't replace any existing o… #### Files - [Get File Metadata](https://docs.cognigy.com/api-reference/files/get-file-metadata.md): Gets file metadata without the binary content. - [Get Binary Data of a File](https://docs.cognigy.com/api-reference/files/get-binary-data-of-a-file.md): Gets the binary data of a file object using its file token. #### Flows - [Get Flows](https://docs.cognigy.com/api-reference/flows/get-flows.md): Gets Flows from a Project. By default, 25 Flows are returned. To change this value, use the `limit` query parameter. Additionally, use `withAiAgents=true` to include AI Agent information for each Flow. - [Create a Flow](https://docs.cognigy.com/api-reference/flows/create-a-flow.md): Creates a Flow in a Project. - [Perform Batch Operations on Flows](https://docs.cognigy.com/api-reference/flows/perform-batch-operations-on-flows.md): Performs batch operations on Flows. - [Get a Flow](https://docs.cognigy.com/api-reference/flows/get-a-flow.md): Gets a Flow from a Project. - [Delete a Flow](https://docs.cognigy.com/api-reference/flows/delete-a-flow.md): Deletes a Flow from a Project. - [Update a Flow](https://docs.cognigy.com/api-reference/flows/update-a-flow.md): Updates a Flow in a Project. Allows modifying of a Flow's name, description, and locale. - [Add a Locale to a Flow](https://docs.cognigy.com/api-reference/flows/add-a-locale-to-a-flow.md): Adds a Locale to a Flow. - [Get the Chart of specified Flow](https://docs.cognigy.com/api-reference/flows/get-the-chart-of-specified-flow.md): Gets the Chart of the specified Flow. - [Create a Flow from a Child Node](https://docs.cognigy.com/api-reference/flows/create-a-flow-from-a-child-node.md): Creates a Flow from a child Node. Moves the Nodes following the child Node to the newly created Flow. The original Flow receives an Execute Flow Node pointing to the new Flow. This method only works if the child Node is followed by other Nodes. - [Clone a Flow](https://docs.cognigy.com/api-reference/flows/clone-a-flow.md): Creates a copy of an existing Flow in a Project. - [Remove a Locale from a Flow](https://docs.cognigy.com/api-reference/flows/remove-a-locale-from-a-flow.md): Removes a Locale from a Flow in a Project. - [Get Flow Settings](https://docs.cognigy.com/api-reference/flows/get-flow-settings.md): Gets Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, locale settings, thresholds, Yes/No logic, and Slot usage. All metadata, such as creation and modification timestamps and user information, is also included. - [Update Flow Settings](https://docs.cognigy.com/api-reference/flows/update-flow-settings.md): Updates Flow settings, including execution behavior, Slot parsing, Intent mapping, default replies, Locale settings, thresholds, Yes/No logic, and Slot usage. #### Functions - [Get Functions](https://docs.cognigy.com/api-reference/functions/get-functions.md): Gets Functions from a Project. By default, 25 Functions are returned. To change this value, use the `limit` query parameter. - [Create a Function](https://docs.cognigy.com/api-reference/functions/create-a-function.md): Creates a Function in a Project. - [Get a Function](https://docs.cognigy.com/api-reference/functions/get-a-function.md): Gets a Function from a Project. - [Delete a Function](https://docs.cognigy.com/api-reference/functions/delete-a-function.md): Deletes a Function from a Project. - [Update a Function](https://docs.cognigy.com/api-reference/functions/update-a-function.md): Updates a Function in a Project. Allows modifying of a Function’s name, source code, or enabled state. You can also disable the Function without deleting it. - [Get Function Instances](https://docs.cognigy.com/api-reference/functions/get-function-instances.md): Gets Function instances from a Function. By default, 25 Function instances are returned. To change this value, use the `limit` query parameter. - [Get a Function Instance](https://docs.cognigy.com/api-reference/functions/get-a-function-instance.md): Gets a Function instance from a Function. - [Stop a Function Instance](https://docs.cognigy.com/api-reference/functions/stop-a-function-instance.md): Stops a Function instance. This method immediately halts the running function. - [Create a Function Instance](https://docs.cognigy.com/api-reference/functions/create-a-function-instance.md): Creates a Function instance. This method triggers the function scheduler to execute the Function immediately. #### Handover Providers - [Get Handover Providers](https://docs.cognigy.com/api-reference/handover-providers/get-handover-providers.md): Gets handover providers for a Project. - [Create a Handover Provider](https://docs.cognigy.com/api-reference/handover-providers/create-a-handover-provider.md): Creates a handover provider in a Project. - [Get a Handover Provider](https://docs.cognigy.com/api-reference/handover-providers/get-a-handover-provider.md): Gets a handover provider from a Project. - [Delete a Handover Provider](https://docs.cognigy.com/api-reference/handover-providers/delete-a-handover-provider.md): Deletes a handover provider from a Project. - [Update a Handover Provider](https://docs.cognigy.com/api-reference/handover-providers/update-a-handover-provider.md): Updates a handover provider in a Project. #### Handover Services - [Get Handover Services](https://docs.cognigy.com/api-reference/handover-services/get-handover-services.md): Gets handover services. - [Get a Handover Service](https://docs.cognigy.com/api-reference/handover-services/get-a-handover-service.md): Gets a handover service from a Project. #### Identity Providers - [Set Up an Identity Provider](https://docs.cognigy.com/api-reference/identity-providers/set-up-an-identity-provider.md): Sets up an identity provider (SAML or OIDC) for your organization, including login/logout URLs, certificates, client credentials, and security settings, enabling Single Sign-On (SSO) authentication. - [Reset an Identity Provider Setup](https://docs.cognigy.com/api-reference/identity-providers/reset-an-identity-provider-setup.md): Resets an identity provider setup for the organization by removing the configured identity provider and all related authentication settings. Use this method to clear the existing SSO configuration. #### Intent Trainer - [Get Trainer Records](https://docs.cognigy.com/api-reference/intent-trainer/get-trainer-records.md): Gets [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer) in a Project. By default, 25 Trainer Records are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Get an Intent Trainer Record](https://docs.cognigy.com/api-reference/intent-trainer/get-an-intent-trainer-record.md): Gets an [Intent Trainer record](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer) from a Project. - [Perform Batch Operations on Intent Trainer Records](https://docs.cognigy.com/api-reference/intent-trainer/perform-batch-operations-on-intent-trainer-records.md): Performs batch operations on [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer). - [Create a Download Link for Intent Trainer Records](https://docs.cognigy.com/api-reference/intent-trainer/create-a-download-link-for-intent-trainer-records.md): Creates a link to download packaged [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer). - [Package Intent Trainer Records](https://docs.cognigy.com/api-reference/intent-trainer/package-intent-trainer-records.md): Creates a task that packages [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer). - [Upload an Intent Trainer Records Package](https://docs.cognigy.com/api-reference/intent-trainer/upload-an-intent-trainer-records-package.md): Uploads a package with [Intent Trainer records](https://docs.cognigy.com/ai/platform-features/nlu/intents/intent-trainer). #### Intents - [Get Intents](https://docs.cognigy.com/api-reference/intents/get-intents.md): Gets Intents from a Flow. By default, 25 Intents are returned. To change this value, use the `limit` query parameter. - [Create an Intent](https://docs.cognigy.com/api-reference/intents/create-an-intent.md): Creates an Intent in a Flow. - [Perform Batch Operations on Intents](https://docs.cognigy.com/api-reference/intents/perform-batch-operations-on-intents.md): Performs batch operations on Intents in a Flow. Use this method to create, update, or delete multiple Intents in a request by specifying the operation type (`create`, `update`, or `delete`) for each item in the operations array. - [Get an Intent](https://docs.cognigy.com/api-reference/intents/get-an-intent.md): Gets an Intent from a Flow. - [Delete an Intent](https://docs.cognigy.com/api-reference/intents/delete-an-intent.md): Deletes an Intent from a Flow. - [Update an Intent](https://docs.cognigy.com/api-reference/intents/update-an-intent.md): Update an Intent in a Flow. Allows modifying of an Intent's name, description, rules, tags, and status. You can also enable or disable the Intent, mark it as a reject Intent, adjust child/parent intent relationships, and override default reply settings. - [Localize an Intent](https://docs.cognigy.com/api-reference/intents/localize-an-intent.md): Adds a localized version of an Intent in a Flow. You can specify the target Locale, optionally inherit content from another Locale, and provide translation settings to adapt the Intent for different languages or regions. - [Delete Intent Localization](https://docs.cognigy.com/api-reference/intents/delete-intent-localization.md): Deletes a localization from an Intent. Use this method to delete translations or Locale-specific data associated with the Intent. - [Export Intents](https://docs.cognigy.com/api-reference/intents/export-intents.md): Exports the Intents of a Flow. You can specify a Locale and select the export format, CSV or JSON file. - [Upload Intents](https://docs.cognigy.com/api-reference/intents/upload-intents.md): Uploads Intents and creates a Task to import the Intents. The supported file format is CSV. - [Train Intents](https://docs.cognigy.com/api-reference/intents/train-intents.md): Starts a Task to train the Intents of a Flow. #### Knowledge Chunks - [Get Knowledge Chunks](https://docs.cognigy.com/api-reference/knowledge-chunks/get-knowledge-chunks.md): Gets Knowledge Chunks from a Knowledge Source. By default, 25 Knowledge Chunks are returned. To change this value, use the `limit` query parameter. - [Create a Knowledge Chunk](https://docs.cognigy.com/api-reference/knowledge-chunks/create-a-knowledge-chunk.md): Creates a Knowledge Chunk in a Knowledge Resource. - [Get a Knowledge Chunk](https://docs.cognigy.com/api-reference/knowledge-chunks/get-a-knowledge-chunk.md): Gets a Knowledge Chunk from a Knowledge Source. - [Delete a Knowledge Chunk](https://docs.cognigy.com/api-reference/knowledge-chunks/delete-a-knowledge-chunk.md): Deletes a Knowledge Chunk from a Knowledge Source. - [Update a Knowledge Chunk](https://docs.cognigy.com/api-reference/knowledge-chunks/update-a-knowledge-chunk.md): Updates a Knowledge Chunk in a Knowledge Source. Allows modifying the Chunk's text, data, order, and status. #### Knowledge Connectors - [Get Knowledge Connectors](https://docs.cognigy.com/api-reference/knowledge-connectors/get-knowledge-connectors.md): Gets a list of Knowledge Connectors. - [Create a Knowledge Connector](https://docs.cognigy.com/api-reference/knowledge-connectors/create-a-knowledge-connector.md): Creates a Knowledge Connector. - [Get a Knowledge Connector](https://docs.cognigy.com/api-reference/knowledge-connectors/get-a-knowledge-connector.md): Gets a Knowledge Connector from a Project. - [Delete a Knowledge Connector](https://docs.cognigy.com/api-reference/knowledge-connectors/delete-a-knowledge-connector.md): Deletes a Knowledge Connector from a Knowledge Store. - [Update a Knowledge Connector](https://docs.cognigy.com/api-reference/knowledge-connectors/update-a-knowledge-connector.md): Updates a Knowledge Connector resource in a Project. Allows modifying a Knowledge Connector’s configuration and name. - [Run a Knowledge Connector](https://docs.cognigy.com/api-reference/knowledge-connectors/run-a-knowledge-connector.md): Runs a Knowledge Connector to extract and import knowledge from external sources. - [Get Knowledge Connectors](https://docs.cognigy.com/api-reference/knowledge-connectors/get-knowledge-connectors-1.md): Gets information about the Knowledge Connectors from a Project. #### Knowledge Sources - [Run a Knowledge Extension](https://docs.cognigy.com/api-reference/knowledge-sources/run-a-knowledge-extension.md): Runs a Knowledge Extension to extract and import knowledge from external sources. - [Get Knowledge Sources](https://docs.cognigy.com/api-reference/knowledge-sources/get-knowledge-sources.md): Gets Knowledge Sources from a Knowledge Store. By default, 25 Knowledge Sources are returned. You can change this number using the `limit` parameter. - [Create a Knowledge Source](https://docs.cognigy.com/api-reference/knowledge-sources/create-a-knowledge-source.md): Creates a Knowledge Source in a Knowledge Store. You define the source metadata and type—no file is uploaded. Use this method for manual sources, URL sources (for web scraping), or when creating the source first and ingesting content later (pdf, txt, ctxt). - [Get a Knowledge Source](https://docs.cognigy.com/api-reference/knowledge-sources/get-a-knowledge-source.md): Gets a Knowledge Source from a Knowledge Store. - [Delete a Knowledge Source](https://docs.cognigy.com/api-reference/knowledge-sources/delete-a-knowledge-source.md): Deletes a Knowledge Source from a Knowledge Store. - [Updates a Knowledge Source](https://docs.cognigy.com/api-reference/knowledge-sources/updates-a-knowledge-source.md): Updates a Knowledge Source in a Knowledge Store. Allows modifying a Source's name, description, status, and metadata. - [Create a Knowledge Source from a File](https://docs.cognigy.com/api-reference/knowledge-sources/create-a-knowledge-source-from-a-file.md): Creates a Knowledge Source in the Knowledge Store by uploading a file and asynchronously ingesting its content. Supported file formats pdf, txt, ctxt. #### Knowledge Stores - [Get Knowledge Stores](https://docs.cognigy.com/api-reference/knowledge-stores/get-knowledge-stores.md): Gets Knowledge Stores from a Project. By default, 25 Knowledge Stores are returned. To change this value, use the `limit` query parameter. - [Create a Knowledge Store](https://docs.cognigy.com/api-reference/knowledge-stores/create-a-knowledge-store.md): Creates a Knowledge Store in a Project. - [Get a Knowledge Store](https://docs.cognigy.com/api-reference/knowledge-stores/get-a-knowledge-store.md): Gets a Knowledge Store from a Project. - [Delete a Knowledge Store](https://docs.cognigy.com/api-reference/knowledge-stores/delete-a-knowledge-store.md): Deletes a Knowledge Store from a Project. - [Update a Knowledge Store](https://docs.cognigy.com/api-reference/knowledge-stores/update-a-knowledge-store.md): Updates a Knowledge Store in a Project. Allows modifying a Store's name and description. #### Large Language Models - [Get large language models](https://docs.cognigy.com/api-reference/large-language-models/get-large-language-models.md): Gets [large language models](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) in a Project. By default, 25 large language models are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a large language model](https://docs.cognigy.com/api-reference/large-language-models/create-a-large-language-model.md): Creates a large language model. The large language model can have the following scopes: - Project (`resourceLevel: 'project'`) - Global (`resourceLevel: 'organisation'`) - [Get a large language model](https://docs.cognigy.com/api-reference/large-language-models/get-a-large-language-model.md): Gets data about a [large language model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms). - [Delete a large language model](https://docs.cognigy.com/api-reference/large-language-models/delete-a-large-language-model.md): Deletes a [large language model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) from a Project. - [Update a large language model](https://docs.cognigy.com/api-reference/large-language-models/update-a-large-language-model.md): Updates a [large language model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms#large-language-models-llms). - [Get models for a large language model provider](https://docs.cognigy.com/api-reference/large-language-models/get-models-for-a-large-language-model-provider.md): Gets the available models for a large language model provider. Returns an empty array if the provider doesn't support model listing. - [Clone a large language model](https://docs.cognigy.com/api-reference/large-language-models/clone-a-large-language-model.md): Clones a [large language model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) in a Project. - [Test large language model connection](https://docs.cognigy.com/api-reference/large-language-models/test-large-language-model-connection.md): Tests the connection to the large language model provider by validating the credentials. - [Get large language models together with their credentials summary and Gateway Config Set status (EXPERIMENTAL)](https://docs.cognigy.com/api-reference/large-language-models/get-large-language-models-together-with-their-credentials-summary-and-gateway-config-set-status-experimental.md): **Experimental and temporary.** Introduced for the C26 unified LLM configuration page. The internal model is expected to change once all large language models are managed as Gateway Config Sets; this route may change or be removed without a major version bump. - [Create a large language model together with its credentials and Gateway Config Set (EXPERIMENTAL)](https://docs.cognigy.com/api-reference/large-language-models/create-a-large-language-model-together-with-its-credentials-and-gateway-config-set-experimental.md): **Experimental and temporary.** Introduced for the C26 unified LLM configuration page. The internal model is expected to change once all large language models are managed as Gateway Config Sets; this route may change or be removed without a major version bump. Use `POST /v2.0/connections` + `POST /v… - [Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)](https://docs.cognigy.com/api-reference/large-language-models/get-a-large-language-model-together-with-its-credentials-summary-and-gateway-config-set-status-experimental.md): **Experimental and temporary.** Introduced for the C26 unified LLM configuration page. The internal model is expected to change once all large language models are managed as Gateway Config Sets; this route may change or be removed without a major version bump. - [Delete a large language model and, optionally, its credentials (EXPERIMENTAL)](https://docs.cognigy.com/api-reference/large-language-models/delete-a-large-language-model-and-optionally-its-credentials-experimental.md): **Experimental and temporary** — see `POST /v2.0/llmconfigurations`. - [Update a large language model together with its credentials and Gateway Config Set (EXPERIMENTAL)](https://docs.cognigy.com/api-reference/large-language-models/update-a-large-language-model-together-with-its-credentials-and-gateway-config-set-experimental.md): **Experimental and temporary** — see `POST /v2.0/llmconfigurations`. #### Lexicons - [Get Lexicons](https://docs.cognigy.com/api-reference/lexicons/get-lexicons.md): Gets [Lexicons](https://docs.cognigy.com/ai/resources/build/lexicons/) in a Project. By default, 25 Lexicons are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a New Lexicon](https://docs.cognigy.com/api-reference/lexicons/create-a-new-lexicon.md): Creates a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Project. - [Perform Batch Operations on Lexicons](https://docs.cognigy.com/api-reference/lexicons/perform-batch-operations-on-lexicons.md): Performs batch create, update, or delete operations on Lexicons in a single request. - [Get a Lexicon](https://docs.cognigy.com/api-reference/lexicons/get-a-lexicon.md): Gets a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Project. - [Delete a Lexicon](https://docs.cognigy.com/api-reference/lexicons/delete-a-lexicon.md): Deletes a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Project. - [Update a Lexicon](https://docs.cognigy.com/api-reference/lexicons/update-a-lexicon.md): Updates a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Project. - [Create a Download Link for a Lexicon](https://docs.cognigy.com/api-reference/lexicons/create-a-download-link-for-a-lexicon.md): Creates a link to download a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) as a CSV file. - [Get Lexicon Entries](https://docs.cognigy.com/api-reference/lexicons/get-lexicon-entries.md): Gets entries from a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon). By default, 25 entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Lexicon Entry](https://docs.cognigy.com/api-reference/lexicons/create-a-lexicon-entry.md): Creates a Lexicon entry with a Keyphrase and optional Lexicon Slots. - [Perform Batch Operations in a Lexicon](https://docs.cognigy.com/api-reference/lexicons/perform-batch-operations-in-a-lexicon.md): Performs batch create, update, or delete operations on Keyphrases and Lexicon Slots in a single request. - [Get a Lexicon Entry](https://docs.cognigy.com/api-reference/lexicons/get-a-lexicon-entry.md): Gets a Lexicon entry from a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon). - [Delete a Lexicon Entry](https://docs.cognigy.com/api-reference/lexicons/delete-a-lexicon-entry.md): Deletes a [Lexicon entry](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. - [Update a Lexicon Entry](https://docs.cognigy.com/api-reference/lexicons/update-a-lexicon-entry.md): Updates a [Lexicon entry](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon). - [Get Keyphrases from a Lexicon Entry](https://docs.cognigy.com/api-reference/lexicons/get-keyphrases-from-a-lexicon-entry.md): Gets [Keyphrases](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry. By default, 25 Keyphrases are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Add a Keyphrase to a Lexicon](https://docs.cognigy.com/api-reference/lexicons/add-a-keyphrase-to-a-lexicon.md): Adds a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/overview#keyphrases) to a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon). - [Delete a Keyphrase](https://docs.cognigy.com/api-reference/lexicons/delete-a-keyphrase.md): Deletes a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry. - [Add a Slot to a Lexicon](https://docs.cognigy.com/api-reference/lexicons/add-a-slot-to-a-lexicon.md): Adds a [Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) to a Lexicon. - [Delete a Lexicon Slot](https://docs.cognigy.com/api-reference/lexicons/delete-a-lexicon-slot.md): Deletes a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon entry. - [Export a Lexicon](https://docs.cognigy.com/api-reference/lexicons/export-a-lexicon.md): Creates a task to export a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) as a CSV file. - [Import a Lexicon](https://docs.cognigy.com/api-reference/lexicons/import-a-lexicon.md): Create a task to import a [Lexicon](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a CSV file. - [Get Keyphrases in a Lexicon](https://docs.cognigy.com/api-reference/lexicons/get-keyphrases-in-a-lexicon.md): Gets [Keyphrases](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. By default, 25 Keyphrases are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Update a Keyphrase](https://docs.cognigy.com/api-reference/lexicons/update-a-keyphrase.md): Updates a [Keyphrase](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon. - [Get Lexicon Slots](https://docs.cognigy.com/api-reference/lexicons/get-lexicon-slots.md): Gets [Lexicon Slots](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. By default, 25 Lexicon Slots are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Lexicon Slot](https://docs.cognigy.com/api-reference/lexicons/create-a-lexicon-slot.md): Creates a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon. You can assign Slots to Keyphrases. - [Perform Batch Operations in a Lexicon](https://docs.cognigy.com/api-reference/lexicons/perform-batch-operations-in-a-lexicon-1.md): Performs batch create, update, or delete operations on Lexicon Slots in a single request. - [Delete a Lexicon Slot](https://docs.cognigy.com/api-reference/lexicons/delete-a-lexicon-slot-1.md): Deletes a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) from a Lexicon. - [Update a Lexicon Slot](https://docs.cognigy.com/api-reference/lexicons/update-a-lexicon-slot.md): Updates a [Lexicon Slot](https://docs.cognigy.com/ai/platform-features/nlu/slots/user-defined/lexicon) in a Lexicon. #### Live Agent - [Get the Live Agent Account](https://docs.cognigy.com/api-reference/live-agent/get-the-live-agent-account.md): Gets the Live Agent Account for the organization. - [Set Up Live Agent](https://docs.cognigy.com/api-reference/live-agent/set-up-live-agent.md): Sets up Cognigy Live Agent for the organization. - [Get the Default Live Agent Inbox](https://docs.cognigy.com/api-reference/live-agent/get-the-default-live-agent-inbox.md): Gets the default Live Agent Inbox from a Project. - [Set Up a Live Agent Inbox](https://docs.cognigy.com/api-reference/live-agent/set-up-a-live-agent-inbox.md): Sets up a default Live Agent Inbox for a Project. - [Update a Live Agent Inbox](https://docs.cognigy.com/api-reference/live-agent/update-a-live-agent-inbox.md): Updates the default Live Agent Inbox assigned to a Project. #### Locales - [Get Locales](https://docs.cognigy.com/api-reference/locales/get-locales.md): Gets [Locales](https://docs.cognigy.com/ai/resources/manage/localization/) in a Project. By default, 25 Locales are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Locale](https://docs.cognigy.com/api-reference/locales/create-a-locale.md): Creates a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization) in a Project. - [Get a Locale](https://docs.cognigy.com/api-reference/locales/get-a-locale.md): Gets a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization). - [Delete a Locale](https://docs.cognigy.com/api-reference/locales/delete-a-locale.md): Deletes a non-primary [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization) in a Project. - [Update a Locale](https://docs.cognigy.com/api-reference/locales/update-a-locale.md): Updates a [Locale](https://docs.cognigy.com/ai/platform-features/translation-and-localization/localization). #### Management UI - [Get Billing Information](https://docs.cognigy.com/api-reference/management-ui/get-billing-information.md): Gets the billing information of organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Get Organizations](https://docs.cognigy.com/api-reference/management-ui/get-organizations.md): Gets organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create an Organization](https://docs.cognigy.com/api-reference/management-ui/create-an-organization.md): Creates an organization in Management UI. - [Get an Organization](https://docs.cognigy.com/api-reference/management-ui/get-an-organization.md): Gets information about an organization. - [Delete an Organization](https://docs.cognigy.com/api-reference/management-ui/delete-an-organization.md): Deletes an organization and the associated data. - [Update an Organization](https://docs.cognigy.com/api-reference/management-ui/update-an-organization.md): Updates information of an organization. - [Create an API Key](https://docs.cognigy.com/api-reference/management-ui/create-an-api-key.md): Creates an API Key with admin permissions. The API Key is valid for 15 minutes. To activate this feature, set the FEATURE_USE_SUPERAPIKEY_API to "true". - [Enforce Password Policy](https://docs.cognigy.com/api-reference/management-ui/enforce-password-policy.md): Enforces a password policy and requests all users to reset their passwords. - [Create a System Message](https://docs.cognigy.com/api-reference/management-ui/create-a-system-message.md): Creates a system message or overwrites the existing one. - [Get the License via Management UI](https://docs.cognigy.com/api-reference/management-ui/get-the-license-via-management-ui.md): Returns the current license state along with company, expiration, signed date and features. Authenticated via Management UI credentials. - [Set the License via Management UI](https://docs.cognigy.com/api-reference/management-ui/set-the-license-via-management-ui.md): Sets the system license, updating license details such as access and quotas. Authenticated via Management UI credentials. - [Get Users](https://docs.cognigy.com/api-reference/management-ui/get-users.md): Gets users of the organization. By default, 25 users are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a User](https://docs.cognigy.com/api-reference/management-ui/create-a-user.md): Creates a user in Management UI. - [Get a User](https://docs.cognigy.com/api-reference/management-ui/get-a-user.md): Gets information about a user. - [Delete a User](https://docs.cognigy.com/api-reference/management-ui/delete-a-user.md): Deletes a user from Management UI. - [Update a User](https://docs.cognigy.com/api-reference/management-ui/update-a-user.md): Updates information of a user. - [Impersonate a User](https://docs.cognigy.com/api-reference/management-ui/impersonate-a-user.md): Creates an access and refresh token pair to log in as a user. - [Get Vendor Information](https://docs.cognigy.com/api-reference/management-ui/get-vendor-information.md): Gets information about a vendor from Management UI. - [Get Billing Information](https://docs.cognigy.com/api-reference/management-ui/get-billing-information-1.md): Gets the billing information of organizations from Management UI. By default, 25 organizations are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. #### NLU Connectors - [Get NLU Connectors](https://docs.cognigy.com/api-reference/nlu-connectors/get-nlu-connectors.md): Gets NLU Connectors in a Project. By default, 25 NLU Connectors are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create an NLU Connector](https://docs.cognigy.com/api-reference/nlu-connectors/create-an-nlu-connector.md): Creates an [NLU Connector](https://docs.cognigy.com/ai/platform-features/nlu/external/nlu-connectors/overview#nlu-connectors) in a Project. - [Perform Batch Operations](https://docs.cognigy.com/api-reference/nlu-connectors/perform-batch-operations.md): Performs batch operations on [NLU Connectors](https://docs.cognigy.com/ai/platform-features/nlu/external/nlu-connectors/overview#nlu-connectors). - [Get an NLU Connector](https://docs.cognigy.com/api-reference/nlu-connectors/get-an-nlu-connector.md): Gets information about an NLU Connector in a Project. - [Delete an NLU Connector](https://docs.cognigy.com/api-reference/nlu-connectors/delete-an-nlu-connector.md): Deletes an NLU Connector. - [Update an NLU Connector](https://docs.cognigy.com/api-reference/nlu-connectors/update-an-nlu-connector.md): Updates an NLU Connector in a Project. #### Nodes - [Get all Node Descriptors](https://docs.cognigy.com/api-reference/nodes/get-all-node-descriptors.md): Gets all Node descriptors of a Flow. A descriptor defines a node type, its capabilities, appearance, and behavior in the Flow Chart. The descriptor acts as a blueprint for creating Nodes. - [Get Nodes](https://docs.cognigy.com/api-reference/nodes/get-nodes.md): Gets Nodes from a Flow. By default, 25 Nodes are returned. Use the `limit` query parameter to change this value. - [Create a Node](https://docs.cognigy.com/api-reference/nodes/create-a-node.md): Creates a new Node in a Flow. - [Get a Node](https://docs.cognigy.com/api-reference/nodes/get-a-node.md): Gets a Node from a Flow. - [Delete a Node](https://docs.cognigy.com/api-reference/nodes/delete-a-node.md): Delete a Node from a Flow. - [Update a Node](https://docs.cognigy.com/api-reference/nodes/update-a-node.md): Updates a Node in a Flow. Allows modifying the Node's type, label, comment, Entrypoint status, and configuration properties. - [Add a New Locale to a Node](https://docs.cognigy.com/api-reference/nodes/add-a-new-locale-to-a-node.md): Adds a new Locale to a Node in a Flow. Use `localeId` to specify the target Locale and `inheritFromLocaleId` to inherit content from an existing Locale. - [Move a Node](https://docs.cognigy.com/api-reference/nodes/move-a-node.md): Moves a Node in a Flow Chart. Allows modifying a Node's position relative to other Nodes using modes such as append, prepend, or insert at a specific position. - [Remove a Locale from a Node](https://docs.cognigy.com/api-reference/nodes/remove-a-locale-from-a-node.md): Removes a Locale from a Node in a Flow. - [Get AI Agents Nodes](https://docs.cognigy.com/api-reference/nodes/get-ai-agents-nodes.md): Gets all AI Agent Nodes from the Flow with full AI Agent details. - [Generate Output for a Node](https://docs.cognigy.com/api-reference/nodes/generate-output-for-a-node.md): Generates content for a Node using generative AI. The generated output, either text or an adaptive card, is returned in the response and can be copied into the Node for testing or development. No node ID is required. - [Search for Nodes](https://docs.cognigy.com/api-reference/nodes/search-for-nodes.md): Searches for Nodes in a flow using a given filter word. Fill in the `filter` parameter to search for Nodes. #### Options Resolver - [Resolve Options for a Field](https://docs.cognigy.com/api-reference/options-resolver/resolve-options-for-a-field.md): Resolves the selected option of a field in an Extension Node editor. This endpoint is accessible only in dedicated SaaS and on-premises installations. #### Packages - [Get Packages](https://docs.cognigy.com/api-reference/packages/get-packages.md): Gets Packages in a Project. By default, 25 Packages are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Package](https://docs.cognigy.com/api-reference/packages/create-a-package.md): Creates a task to create a [Package](https://docs.cognigy.com/ai/resources/build/packages). - [Get a Package](https://docs.cognigy.com/api-reference/packages/get-a-package.md): Gets information about a [Package](https://docs.cognigy.com/ai/resources/build/packages). - [Delete a Package](https://docs.cognigy.com/api-reference/packages/delete-a-package.md): Creates a task to delete a [Package](https://docs.cognigy.com/ai/resources/build/packages). - [Create a Download Link](https://docs.cognigy.com/api-reference/packages/create-a-download-link.md): Creates a link to download a [Package](https://docs.cognigy.com/ai/platform-features/packages). - [Merge a Package](https://docs.cognigy.com/api-reference/packages/merge-a-package.md): Creates a task to merge a [Package](https://docs.cognigy.com/ai/resources/build/packages). - [Upload a Package](https://docs.cognigy.com/api-reference/packages/upload-a-package.md): Uploads a [Package](https://docs.cognigy.com/ai/resources/build/packages) and creates a task to unpack it in the Project. #### Playbooks - [Get Playbooks](https://docs.cognigy.com/api-reference/playbooks/get-playbooks.md): Gets [Playbooks](https://docs.cognigy.com/ai/agents/test/playbooks) in a Project. By default, 25 Playbooks are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Playbook](https://docs.cognigy.com/api-reference/playbooks/create-a-playbook.md): Creates a [Playbook](https://docs.cognigy.com/ai/agents/build/playbooks) in a Project. - [Perform Batch Operations](https://docs.cognigy.com/api-reference/playbooks/perform-batch-operations.md): Performs batch operations on Playbooks. - [Get a Playbook](https://docs.cognigy.com/api-reference/playbooks/get-a-playbook.md): Gets data about a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks). - [Delete a Playbook](https://docs.cognigy.com/api-reference/playbooks/delete-a-playbook.md): Deletes a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks) from a Project. - [Update a Playbook](https://docs.cognigy.com/api-reference/playbooks/update-a-playbook.md): Updates Playbook data in a Project. - [List Playbook Runs](https://docs.cognigy.com/api-reference/playbooks/list-playbook-runs.md): Lists runs from a Playbook. - [Retrieve a Playbook Run](https://docs.cognigy.com/api-reference/playbooks/retrieve-a-playbook-run.md): Retrieves data about a [Playbook run](https://docs.cognigy.com/ai/agents/test/playbooks). - [Delete a Playbook Run](https://docs.cognigy.com/api-reference/playbooks/delete-a-playbook-run.md): Deletes a [Playbook run](https://docs.cognigy.com/ai/agents/test/playbooks) from a Project. - [Schedule a Playbook Run](https://docs.cognigy.com/api-reference/playbooks/schedule-a-playbook-run.md): Schedules a Playbook run. - [Create a Playbook Step](https://docs.cognigy.com/api-reference/playbooks/create-a-playbook-step.md): Creates a step in a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks). - [Delete a Playbook Step](https://docs.cognigy.com/api-reference/playbooks/delete-a-playbook-step.md): Deletes a step from a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks). - [Update a Playbook Step](https://docs.cognigy.com/api-reference/playbooks/update-a-playbook-step.md): Updates a step in a [Playbook](https://docs.cognigy.com/ai/agents/test/playbooks). - [Create an Assertion](https://docs.cognigy.com/api-reference/playbooks/create-an-assertion.md): Creates an [assertion](https://docs.cognigy.com/ai/agents/test/assertions) for a Playbook step. - [Delete a Playbook Step Assertion](https://docs.cognigy.com/api-reference/playbooks/delete-a-playbook-step-assertion.md): Deletes an assertion from a [Playbook step](https://docs.cognigy.com/ai/agents/test/playbooks). - [Update a Playbook Step Assertion](https://docs.cognigy.com/api-reference/playbooks/update-a-playbook-step-assertion.md): Updates an [assertion](https://docs.cognigy.com/ai/agents/test/assertions) from a [Playbook step](https://docs.cognigy.com/ai/agents/test/playbooks). - [Change Step Order](https://docs.cognigy.com/api-reference/playbooks/change-step-order.md): Changes the order of [Playbook steps](https://docs.cognigy.com/ai/agents/test/playbooks). #### Projects - [Get Projects](https://docs.cognigy.com/api-reference/projects/get-projects.md): Gets [Projects](https://docs.cognigy.com/ai/resources/agents/agents/) in an organization. By default, 25 Projects are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Project](https://docs.cognigy.com/api-reference/projects/create-a-project.md): Creates a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects). - [Get a Project](https://docs.cognigy.com/api-reference/projects/get-a-project.md): Gets data from a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects). - [Delete a Project](https://docs.cognigy.com/api-reference/projects/delete-a-project.md): Deletes a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects). - [Update a Project](https://docs.cognigy.com/api-reference/projects/update-a-project.md): Updates the data of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects). - [Get a Graph](https://docs.cognigy.com/api-reference/projects/get-a-graph.md): Gets a graph showing all resources of a Project, Snapshot or Package. - [Generate NLU Scores](https://docs.cognigy.com/api-reference/projects/generate-nlu-scores.md): Generate a NLU score for an sentence by analyzing Intents in a Flow and Locale. - [Get Project Settings](https://docs.cognigy.com/api-reference/projects/get-project-settings.md): Gets the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects). - [Update Project Settings](https://docs.cognigy.com/api-reference/projects/update-project-settings.md): Updates the settings of a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects). - [Set Up Proactive Follow-Up](https://docs.cognigy.com/api-reference/projects/set-up-proactive-follow-up.md): Provisions a Proactive tenant, creates a journey, and generates a follow-up flow. - [Set Up Cognigy Generative AI](https://docs.cognigy.com/api-reference/projects/set-up-cognigy-generative-ai.md): Sets up Cognigy Generative AI for a Project. - [Test a Translation Provider Connection](https://docs.cognigy.com/api-reference/projects/test-a-translation-provider-connection.md): Validates the connection with a translation provider. - [Train Flow Models](https://docs.cognigy.com/api-reference/projects/train-flow-models.md): Trains the NLU model of all Flows in a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects). - [Create a Project from a Template](https://docs.cognigy.com/api-reference/projects/create-a-project-from-a-template.md): Creates a [Project](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#projects) from a template. - [Validate a Project Name](https://docs.cognigy.com/api-reference/projects/validate-a-project-name.md): Checks whether Project name is already used in the organization. #### Search - [Search Resources](https://docs.cognigy.com/api-reference/search/search-resources.md): Searches resources across the organization and list the first 25 results by default. This endpoint searches only for Extensions, Projects, Lexicons, Endpoints, Flows, Functions, Playbooks, NLU Connectors, Snapshots, and Simulations. To change the default number of listed results, use the `limit` que… #### Sessions - [Inject a Context](https://docs.cognigy.com/api-reference/sessions/inject-a-context.md): Injects a context into a session. - [Reset a Context](https://docs.cognigy.com/api-reference/sessions/reset-a-context.md): Resets a context in a session. #### Slot Fillers - [Get Slot Fillers](https://docs.cognigy.com/api-reference/slot-fillers/get-slot-fillers.md): Gets Slot Fillers from a Flow. By default, 25 Slot Fillers are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Slot Filler](https://docs.cognigy.com/api-reference/slot-fillers/create-a-slot-filler.md): Creates a Slot Filler in the Project. - [Perform Batch Operations](https://docs.cognigy.com/api-reference/slot-fillers/perform-batch-operations.md): Performs batch operations on Slot Fillers. - [Get a Slot Filler](https://docs.cognigy.com/api-reference/slot-fillers/get-a-slot-filler.md): Gets a Slot Filler from a Flow. - [Delete a Slot Filler](https://docs.cognigy.com/api-reference/slot-fillers/delete-a-slot-filler.md): Deletes a Slot Filler from the Flow. - [Update a Slot Filler](https://docs.cognigy.com/api-reference/slot-fillers/update-a-slot-filler.md): Updates a Slot Filler from a Flow. #### Snapshots - [Get Snapshots](https://docs.cognigy.com/api-reference/snapshots/get-snapshots.md): Gets [Snapshots](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project. By default, 25 Snapshots are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Snapshot](https://docs.cognigy.com/api-reference/snapshots/create-a-snapshot.md): Creates a task to create a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project. - [Gets a Snapshot](https://docs.cognigy.com/api-reference/snapshots/gets-a-snapshot.md): Gets information about a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project. - [Delete a Snapshot](https://docs.cognigy.com/api-reference/snapshots/delete-a-snapshot.md): Creates a task to delete a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots). - [Create a Download Link](https://docs.cognigy.com/api-reference/snapshots/create-a-download-link.md): Creates a link to download a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots). - [Package a Snapshot](https://docs.cognigy.com/api-reference/snapshots/package-a-snapshot.md): Creates a task to package a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) in a Project. - [Get Resources in a Snapshot](https://docs.cognigy.com/api-reference/snapshots/get-resources-in-a-snapshot.md): Gets resources of a specific type in a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots). By default, 25 resources are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Restore a Snapshot](https://docs.cognigy.com/api-reference/snapshots/restore-a-snapshot.md): Creates a task to restore a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots). - [Upload a Snapshot Package](https://docs.cognigy.com/api-reference/snapshots/upload-a-snapshot-package.md): Uploads a [Snapshot](https://docs.cognigy.com/ai/agents/deploy/snapshots) package and creates a task to unpack it in the Project. #### Tasks - [Get Tasks](https://docs.cognigy.com/api-reference/tasks/get-tasks.md): Gets [tasks](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) from a Project. By default, 25 tasks are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Get a Task](https://docs.cognigy.com/api-reference/tasks/get-a-task.md): Gets a [task](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) from a Project. - [Cancel a Task](https://docs.cognigy.com/api-reference/tasks/cancel-a-task.md): Cancels a [task](https://docs.cognigy.com/ai/agents/develop/projects-and-flows/projects#task-panel) in a Project. #### Tokens - [Get Tokens](https://docs.cognigy.com/api-reference/tokens/get-tokens.md): Gets custom [Tokens](https://docs.cognigy.com/ai/platform-features/tokens) in a Project. By default, 25 Tokens are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. Default Tokens aren't included in the results. - [Create a Token](https://docs.cognigy.com/api-reference/tokens/create-a-token.md): Creates a [Token](https://docs.cognigy.com/ai/platform-features/tokens) in a Project. - [Delete a Token](https://docs.cognigy.com/api-reference/tokens/delete-a-token.md): Deletes a [Token](https://docs.cognigy.com/ai/platform-features/tokens) from a Project. #### Users - [Remove a Project Member](https://docs.cognigy.com/api-reference/users/remove-a-project-member.md): Removes a user from a Project. - [Add a Project Member](https://docs.cognigy.com/api-reference/users/add-a-project-member.md): Adds a user to a Project as a member. - [Get Project Members](https://docs.cognigy.com/api-reference/users/get-project-members.md): Gets [members](https://docs.cognigy.com/ai/resources/manage/members/) of a Project. By default, 25 Project members are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Get a Project Member](https://docs.cognigy.com/api-reference/users/get-a-project-member.md): Gets all information about a member of a Project. - [Update a Project Member](https://docs.cognigy.com/api-reference/users/update-a-project-member.md): Updates information of a Project member. - [Assign a Project Role](https://docs.cognigy.com/api-reference/users/assign-a-project-role.md): Assigns a project role to a user. - [Unassign a Project Role](https://docs.cognigy.com/api-reference/users/unassign-a-project-role.md): Unassigns a Project role from a Project member. - [Get Users](https://docs.cognigy.com/api-reference/users/get-users.md): Gets [users](https://docs.cognigy.com/voicegateway/webapp/users) in the organization. By default, 25 users are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a User](https://docs.cognigy.com/api-reference/users/create-a-user.md): Creates a [user](https://docs.cognigy.com/ai/administer/access/management-ui#create-a-user) in the installation. - [Get a User](https://docs.cognigy.com/api-reference/users/get-a-user.md): Gets all the information from a user. - [Delete a User](https://docs.cognigy.com/api-reference/users/delete-a-user.md): Deletes a user from the system completely. - [Update a User Profile](https://docs.cognigy.com/api-reference/users/update-a-user-profile.md): Updates information of a user profile. - [Assign a Project to a User](https://docs.cognigy.com/api-reference/users/assign-a-project-to-a-user.md): Gives a user access to a Project. - [Assign a Global Role](https://docs.cognigy.com/api-reference/users/assign-a-global-role.md): Assigns a global role to a user. - [Log Out a User](https://docs.cognigy.com/api-reference/users/log-out-a-user.md): Logs out a user and removes the access/refresh token pair. - [Unassign a Project from a User](https://docs.cognigy.com/api-reference/users/unassign-a-project-from-a-user.md): Removes the access to a Project from a user. - [Unassign a Global Role](https://docs.cognigy.com/api-reference/users/unassign-a-global-role.md): Unassigns a global role from a user. - [Reset Failed Login Attempts](https://docs.cognigy.com/api-reference/users/reset-failed-login-attempts.md): Resets the failed login attempts for a user. Requires the 'admin' role. - [Change a User Password](https://docs.cognigy.com/api-reference/users/change-a-user-password.md): Changes the password of a user. - [Deprecate User Passwords](https://docs.cognigy.com/api-reference/users/deprecate-user-passwords.md): Deprecates the password of a single user or all users of the organization. - [Gets the Current User's Profile](https://docs.cognigy.com/api-reference/users/gets-the-current-users-profile.md): Gets the current user's profile information. - [Delete Own User](https://docs.cognigy.com/api-reference/users/delete-own-user.md): Deletes the current [user](https://docs.cognigy.com/ai/administer/access/management-ui#other-operations) from the installation. - [Update Own User](https://docs.cognigy.com/api-reference/users/update-own-user.md): Updates the profile of the current [user](doc:users). - [Accept the Terms of Service](https://docs.cognigy.com/api-reference/users/accept-the-terms-of-service.md): Accepts the terms of service. - [Get Current User's ACL](https://docs.cognigy.com/api-reference/users/get-current-users-acl.md): Gets the access control list (ACL) information for the current user's profile. - [Get API Keys of the Current User](https://docs.cognigy.com/api-reference/users/get-api-keys-of-the-current-user.md): Gets API keys of the current user. By default, 25 API keys are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create an API Key](https://docs.cognigy.com/api-reference/users/create-an-api-key.md): Creates an [API key](https://docs.cognigy.com/ai/administer/user-menu/my-profile#api-keys) for the current user. - [Delete an API Key](https://docs.cognigy.com/api-reference/users/delete-an-api-key.md): Deletes an [API key](https://docs.cognigy.com/ai/administer/user-menu/my-profile#api-keys) for the current user. - [Get the Last Login Attempt](https://docs.cognigy.com/api-reference/users/get-the-last-login-attempt.md): Gets the current user's last login attempt. - [Get Login Attempts of the Current User](https://docs.cognigy.com/api-reference/users/get-login-attempts-of-the-current-user.md): Gets login attempts for the current user. By default, 25 login attempts are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Pin or Unpin Resources](https://docs.cognigy.com/api-reference/users/pin-or-unpin-resources.md): Pins or unpins Cognigy.AI resources, such as Projects, to organize them based on your preferences. - [Get Pinned Resources](https://docs.cognigy.com/api-reference/users/get-pinned-resources.md): Gets pinned Cognigy.AI resources by resource type. - [Request a Password Reset](https://docs.cognigy.com/api-reference/users/request-a-password-reset.md): Requests a password reset email. - [Reset a User Password](https://docs.cognigy.com/api-reference/users/reset-a-user-password.md): Resets a user's password using a provided token. - [Validate a Password Reset Token](https://docs.cognigy.com/api-reference/users/validate-a-password-reset-token.md): Checks if the user password reset token is valid. #### Users 2.1 - [Get API Keys of the Current User](https://docs.cognigy.com/api-reference/users-21/get-api-keys-of-the-current-user.md): Gets API keys of the current user. By default, 25 API keys are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create an API Key](https://docs.cognigy.com/api-reference/users-21/create-an-api-key.md): Creates an [API key](https://docs.cognigy.com/ai/tools/user-menu/my-profile/#api-keys) for the current user. #### Voice Gateway - [Get Voice Gateway Account](https://docs.cognigy.com/api-reference/voice-gateway/get-voice-gateway-account.md): Gets information from the Voice Gateway account. - [Set Up a Voice Gateway Account](https://docs.cognigy.com/api-reference/voice-gateway/set-up-a-voice-gateway-account.md): Sets up a Voice Gateway account for the organization. - [Get Voice Gateway Speech Credentials](https://docs.cognigy.com/api-reference/voice-gateway/get-voice-gateway-speech-credentials.md): Gets speech credentials associated with the Voice Gateway account for the organisation. - [Get Voice Gateway Supported Voices](https://docs.cognigy.com/api-reference/voice-gateway/get-voice-gateway-supported-voices.md): Gets supported languages and voices for a given speech credential. #### Voice Preview - [Get Voices](https://docs.cognigy.com/api-reference/voice-preview/get-voices.md): Gets available preview voices for the speech provider selected in the Project settings. - [Validate Speech Provider](https://docs.cognigy.com/api-reference/voice-preview/validate-speech-provider.md): Validates the credentials of a speech provider connection. #### Webfinger - [Get User or Organization Info via Webfinger for SSO](https://docs.cognigy.com/api-reference/webfinger/get-user-or-organization-info-via-webfinger-for-sso.md): Gets data from an Identity Provider (IdP) configuration for SSO authentication based on a user email or organization ID via the [WebFinger protocol](https://en.wikipedia.org/wiki/WebFinger). #### Yes/No Intents - [Get Yes/No Intents](https://docs.cognigy.com/api-reference/yesno-intents/get-yesno-intents.md): Gets the [Yes/No Intents](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents) of a Locale. - [Delete a Yes/No Intent](https://docs.cognigy.com/api-reference/yesno-intents/delete-a-yesno-intent.md): Deletes a Yes/No Intent. Once deleted, you can't recreate the Yes/No Intent. You need a new Locale to have Yes/No Intents. - [Update a Yes/No Intent](https://docs.cognigy.com/api-reference/yesno-intents/update-a-yesno-intent.md): Updates a Yes/No Intent of a Locale. - [Get Sentences](https://docs.cognigy.com/api-reference/yesno-intents/get-sentences.md): Gets sentences from a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents). By default, 25 sentences are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. - [Create a Sentence](https://docs.cognigy.com/api-reference/yesno-intents/create-a-sentence.md): Creates a Sentence for a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents). - [Get a Sentence](https://docs.cognigy.com/api-reference/yesno-intents/get-a-sentence.md): Gets a Sentence from a Yes/No Intent. - [Delete a Sentence](https://docs.cognigy.com/api-reference/yesno-intents/delete-a-sentence.md): Deletes a Sentence from a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents). - [Update a Sentence](https://docs.cognigy.com/api-reference/yesno-intents/update-a-sentence.md): Updates a Sentence in a [Yes/No Intent](docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents). - [Train Yes/No Intents](https://docs.cognigy.com/api-reference/yesno-intents/train-yesno-intents.md): Creates a task to train the [Yes/No Intents](https://docs.cognigy.com/ai/nlu/nlu-overview/yes-no-intents/) of a Locale. - [Train Yes/No Intents for All Locales](https://docs.cognigy.com/api-reference/yesno-intents/train-yesno-intents-for-all-locales.md): Creates tasks to train the [Yes/No Intents](https://docs.cognigy.com/ai/platform-features/nlu/intents/yes-no-intents#yes-no-intents) for all Locales in a Project. ### Simulator #### Simulations - [Get all scenarios](https://docs.cognigy.com/api-reference-simulator/simulations/get-all-scenarios.md): Retrieve a paginated list of scenarios for the authenticated user's organization and project. - [Create scenario](https://docs.cognigy.com/api-reference-simulator/simulations/create-scenario.md): Create a scenario with the provided configuration. - [Get all simulations](https://docs.cognigy.com/api-reference-simulator/simulations/get-all-simulations.md): Retrieve a paginated list of all simulations. - [Get scenario by ID](https://docs.cognigy.com/api-reference-simulator/simulations/get-scenario-by-id.md): Retrieve a specific scenario by its reference ID. - [Delete scenario](https://docs.cognigy.com/api-reference-simulator/simulations/delete-scenario.md): Delete a scenario and all its associated data. - [Update scenario](https://docs.cognigy.com/api-reference-simulator/simulations/update-scenario.md): Update an existing scenario with new configuration. - [Run scenario](https://docs.cognigy.com/api-reference-simulator/simulations/run-scenario.md): Run multiple executions of a scenario. - [Get simulations by scenarios](https://docs.cognigy.com/api-reference-simulator/simulations/get-simulations-by-scenarios.md): Retrieve all simulations for a specific scenario. - [Get simulation by ID](https://docs.cognigy.com/api-reference-simulator/simulations/get-simulation-by-id.md): Retrieve a specific simulation by its reference ID. - [Stop simulation](https://docs.cognigy.com/api-reference-simulator/simulations/stop-simulation.md): Stop a running simulation and all its active runs. - [Clone scenario](https://docs.cognigy.com/api-reference-simulator/simulations/clone-scenario.md): Clone a scenario and optionally provide a new name for the cloned scenario. - [Get scheduler configuration for a simulation](https://docs.cognigy.com/api-reference-simulator/simulations/get-scheduler-configuration-for-a-simulation.md): Retrieve the scheduler configuration associated with a specific simulation. - [Create a scheduler for a simulation](https://docs.cognigy.com/api-reference-simulator/simulations/create-a-scheduler-for-a-simulation.md): Create a scheduler associated with a scenario to run simulations automatically. - [Update a scheduler by reference](https://docs.cognigy.com/api-reference-simulator/simulations/update-a-scheduler-by-reference.md): Update fields of an existing scheduler configuration by its reference. #### Simulation Runs - [Get simulation runs by simulation](https://docs.cognigy.com/api-reference-simulator/simulation-runs/get-simulation-runs-by-simulation.md): Retrieve all simulation runs for a specific simulation. - [Get simulation run by ID](https://docs.cognigy.com/api-reference-simulator/simulation-runs/get-simulation-run-by-id.md): Retrieve a specific simulation run by its reference ID. #### Personas - [Get persona options (mission types and persona types)](https://docs.cognigy.com/api-reference-simulator/personas/get-persona-options-mission-types-and-persona-types.md): Smart endpoint that handles multiple scenarios for getting persona options: - **Legacy**: Provide only `flowId` to analyze the entire flow - **AI Agent Specific**: Provide `flowId` + `aiagentReferenceId` to analyze a specific AI agent - **Job Node Specific**: Provide `flowId` + `aiagentReferenceId`… - [Generate persona packages](https://docs.cognigy.com/api-reference-simulator/personas/generate-persona-packages.md): Generate persona packages based on selected mission type and persona type with auto-discovery of AI agents and tools from the flow. This endpoint creates complete persona packages including scenario names, persona descriptions, missions, and success criteria. - [Regenerate a specific field of a persona package](https://docs.cognigy.com/api-reference-simulator/personas/regenerate-a-specific-field-of-a-persona-package.md): Regenerate a specific field of a persona package using LLM. Requires the full persona package context to regenerate any individual field. Valid fields to regenerate: simulationName, personaName, personaDescription, mission, successCriteria - [Bulk generate separated personas and missions](https://docs.cognigy.com/api-reference-simulator/personas/bulk-generate-separated-personas-and-missions.md): Generate separated persona and mission information for all provided persona types and mission types. Returns personas and missions in separated structures for independent management. - [Create scenario from transcript](https://docs.cognigy.com/api-reference-simulator/personas/create-scenario-from-transcript.md): Create a scenario draft by analyzing a conversation transcript. The system uses LLM to extract user intent, conversation goals, and user characteristics from the transcript, then generates an appropriate persona package. #### Dashboard - [Get dashboard overview metrics](https://docs.cognigy.com/api-reference-simulator/dashboard/get-dashboard-overview-metrics.md): Retrieve key metrics for the dashboard overview cards including total scenarios, simulations, average success rate, and scheduled runs count. - [Get success rate trend data](https://docs.cognigy.com/api-reference-simulator/dashboard/get-success-rate-trend-data.md): Retrieve 7-day rolling average trend of simulation outcomes for visualization. Returns daily aggregated data showing successful vs failed runs. - [Get upcoming scheduled runs](https://docs.cognigy.com/api-reference-simulator/dashboard/get-upcoming-scheduled-runs.md): Retrieve list of upcoming scheduled simulation runs with scenario name, next run time, and frequency information. #### Transcript Scenario Generation - [Create transcript upload request](https://docs.cognigy.com/api-reference-simulator/transcript-scenario-generation/create-transcript-upload-request.md): Create a new transcript upload session. This is the first step in the three-step workflow for generating scenarios from transcript files. - [Upload and parse a transcript file](https://docs.cognigy.com/api-reference-simulator/transcript-scenario-generation/upload-and-parse-a-transcript-file.md): Upload a single transcript file for parsing and content extraction. This is the second step in the three-step workflow. - [Generate scenarios from uploaded transcripts](https://docs.cognigy.com/api-reference-simulator/transcript-scenario-generation/generate-scenarios-from-uploaded-transcripts.md): Generate 3 distinct simulation scenarios from previously uploaded and parsed transcript files. This is the third and final step in the three-step workflow. ### Logs #### Logs - [Get Log Entries](https://docs.cognigy.com/api-reference-logs/logs/get-log-entries.md): Gets [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. By default, 25 log entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. If you provide an invalid `cursor` value, a 400 error will be r… - [Get a Log Entry](https://docs.cognigy.com/api-reference-logs/logs/get-a-log-entry.md): Gets a [log entry](https://docs.cognigy.com/ai/agents/test/logs) in a Project. This endpoint is deprecated, use `/v2.1/projects/{projectId}/logs/{logEntryId}` instead. - [Get the Latest Log Entries](https://docs.cognigy.com/api-reference-logs/logs/get-the-latest-log-entries.md): Gets the latest 100 [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. Uses aggregation to first get the latest rows by `_id`, then sorts by timestamp. Supports `cursor`-based pagination using the `_id` field. If you provide an invalid `cursor` value, a 400 error will be retur… #### Logs v2.1 - [Get Log Entries](https://docs.cognigy.com/api-reference-logs/logs-v21/get-log-entries.md): Gets [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. By default, 25 log entries are returned. To change this value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results. If you provide an invalid `cursor` value, a 400 error will be r… - [Get a Log Entry](https://docs.cognigy.com/api-reference-logs/logs-v21/get-a-log-entry.md): Gets a [log entry](https://docs.cognigy.com/ai/agents/test/logs) in a Project. When the request header `x-cognigy-log-model-version` is set to `v2`, the response uses the V2 shape with a nested `metadata` object containing `organizationId`, `projectId`, and `type` instead of a top-level `type` field… - [Count Log Entries by Level](https://docs.cognigy.com/api-reference-logs/logs-v21/count-log-entries-by-level.md): Counts [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project per log level (`fatal`, `error`, `warn`, `info`, `debug` — `trace` is not counted), using the same `userId`, `flowName` and `sessionId` filters as the tail endpoint, so a count can be rendered alongside a filtered tail w… - [Package Log Entries into a downloadable file](https://docs.cognigy.com/api-reference-logs/logs-v21/package-log-entries-into-a-downloadable-file.md): **Availability:** this endpoint is an optional feature that is disabled by default. It has to be enabled for your Cognigy.AI environment before it can be used. While it is disabled, requests to it return `404 Not Found`. Contact Cognigy Support to have the feature enabled for your environment. - [Download a packaged Logs file](https://docs.cognigy.com/api-reference-logs/logs-v21/download-a-packaged-logs-file.md): **Availability:** this endpoint is an optional feature that is disabled by default. It has to be enabled for your Cognigy.AI environment before it can be used. While it is disabled, requests to it return `404 Not Found`. Contact Cognigy Support to have the feature enabled for your environment. - [Get the Latest Log Entries](https://docs.cognigy.com/api-reference-logs/logs-v21/get-the-latest-log-entries.md): Gets the latest 100 [log entries](https://docs.cognigy.com/ai/agents/test/logs) in a Project. Results are sorted descending by timestamp and `_id`. Supports cursor-based pagination via opaque base64url tokens returned in `nextCursor` and `previousCursor`. The `total` field is always `-1` because cou… ## OpenAPI Specs - [openapi-viewer](https://api-trial.cognigy.ai/openapi/openapi-viewer.json) - [openapi-viewer](https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json) - [openapi-viewer](https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json)