API Interface
Overview
Insight Agent provides APIs for integration with external systems. Developers can create analysis tasks and retrieve conversation details to incorporate insight analysis into custom applications, business systems, and automated workflows.
The API documentation platform maintains endpoint definitions, request parameters, response structures, and debugging instructions. Refer to that platform for the authoritative details.
APIs
| API | Method | Description | Documentation |
|---|---|---|---|
| Create an Insight Agent Task | POST | Create an Insight Agent analysis task. | Create an Insight Agent Task |
| Retrieve Conversation Details | GET | Retrieve the details of an Insight Agent conversation. | Retrieve Conversation Details |
Usage Notes
Before calling the APIs, activate the required Insight Agent license and configure the agent and its permissions. The API caller must have permission to access the target agent and conversation data.
Refer to the API documentation platform for fields, authentication, error codes, and request examples. The help center does not duplicate field-level specifications when the API documentation changes.