AssignX API Documentation
This is the complete API documentation for connecting to the AssignX API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet AssignX: AssignX is an AI sales agent platform whose public API is still documented on the legacy AgentX domain. This app wraps the documented REST API for reading agents and managing agent conversations. Keep reading to get started.
Quickstart
Before you run your first AssignX request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one AssignX connection — create or choose one in Connections. Note its
connectionId.
Every AssignX action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/assignX/actions/{actionSlug}/runYou need a MindCloud API Key and a AssignX connection. Then call an action such as Get User Profile:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/assignX/actions/get-user-profile/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your AssignX account. See AssignX API Authentication for the full flow and how to get your connection credentials.
AssignX actions
All 12 published actions for this AssignX version. Each page documents the endpoint, arguments, and response controls.
- POSTCreate Conversation
- GETGet Conversation Detail
- GETGet Prompt Trace Detail
- GETGet Prompt Trace for Message
- GETGet User Profile
- GETList Agents
- GETList Conversations
- DELETEReset Conversation Context
- POSTSend Message to Conversation
- POSTSend Message to Conversation (SSE)
- POSTSend Message to Conversation (SSE) with Stream
- POSTSend Message to Conversation with Attachment
Related apps
More Artificial Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.