Integration & API
Connect your scripts or services to DesireCore using the address and credentials for the service you need. The guides cover connection checks, conversations and results, Agent Webhooks, model protocols, and workflow integration.
Choose a guide
| Goal | Requirements | Guide |
|---|---|---|
| Connect an instance | Administrator-provided HTTPS address and instance token | Connection and authentication |
| Submit conversations and follow results | Instance owner access, Agent ID, Node.js 22+ for the example | Conversations and Runs |
| Trigger an Agent from external events | Enabled event and Agent-level Webhook secret; owner configuration requires the webhookManagement capability | Agent Webhook |
| Call model protocols through the local proxy | Running local proxy and provider-bound safe token | Model proxy |
| Trigger an existing workflow | Separate Workflow Service address, service token, and administrator-provided definition | Workflow integration |
| Import HTTP contracts into a tool | Select the spec for your service | OpenAPI downloads |
| Let DesireCore call your business service | MCP server, tools or skills | MCP integration and integration overview |
Credentials and results
Agent Service uses X-Agent-Service-Token; external Webhooks use Authorization: Bearer <Webhook secret>. Model proxy credentials and Workflow Service tokens have their own scope. A provider API Key does not substitute for an instance credential.
A handshake 200 confirms the authenticated request. Query submission 202 and Webhook 200 accepted acknowledge admission or receipt; follow the corresponding guide to observe completion and delivery. Conversation events use Socket.IO, while Workflow progress uses SSE.
Start integrating
- Obtain the actual service address and its credential. Use verified HTTPS for remote access.
- Complete the connection check or the selected guide's minimal example.
- Check the actual response and result delivery. See errors and troubleshooting for failures.
https://docs.desirecore.com/api is a documentation page. Send API requests to your own instance address, such as https://agent.example.com.