API Documentation

Everything an agent does through these interfaces runs on xpander: every call to a model or a company system is validated, credentialed at the moment of use, budgeted, and recorded under the person who asked. Pick the interface that fits:

REST API

REST APIHTTPS endpoints for agents, tasks, skills, knowledge and workflows, from any language.

Model Context Protocol

MCP for Claude & IDEsReach agents and skills over MCP from Claude Desktop, Cursor, and other MCP clients.

Quick Comparison

Feature	REST API	Model Context Protocol
Language Support	Any language	Any MCP client
Primary Use Case	Control plane operations	Discovering & invoking agents
Setup Complexity	Minimal (API key)	MCP client config
Best For	CRUD operations, integrations	IDE/AI client integration
Real-time	Polling or webhooks	Server-Sent Events

Getting Started

Get API Credentials

Register at chat.xpander.ai (free on the cloud edition) or sign in to your organization’s self-hosted app, then generate your API key under Settings

Choose Your Integration

REST API: For universal access from any language
MCP Protocol: For IDE and AI client integration

Follow the Guide

The REST page opens with a curl call, the MCP page with a client configuration.

REST API

The REST API manages your resources:

# List agents
curl -X GET "https://api.xpander.ai/v1/agents" \
  -H "x-api-key: YOUR_API_KEY"

# Invoke an agent
curl -X POST "https://api.xpander.ai/v1/agents/{agent_id}/invoke" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input": {"text": "Analyze this data"}}'

Explore REST API

Every endpoint with its request and response schema

Model Context Protocol - Expose to Claude & IDEs

Connect your agents and skills to Claude Desktop, Cursor, and other MCP clients. The endpoint signs the client in with OAuth 2.1 in the browser; no key goes into the file:

{
  "mcpServers": {
    "xpander": {
      "command": "npx",
      "args": ["-y", "mcp-remote@latest", "https://api.xpander.ai/mcp/"]
    }
  }
}

Explore MCP Integration

View complete MCP setup guide with examples

Authentication

REST calls and webhooks authenticate with an API key; the MCP endpoint uses OAuth 2.1 instead:

export XPANDER_API_KEY="your-api-key"

Generate your API key under Settings in Xpander Chat (chat.xpander.ai on the cloud edition, your own address when self-hosted).

Common Use Cases

Integrating with Existing Applications

Use REST API for integrating xpander into existing applications written in any language. Perfect for microservices, web apps, and mobile applications.

IDE and AI Client Access

Use Model Context Protocol for accessing agents from Claude Desktop, Cursor, VSCode, or any MCP-compatible client. Enables agent discovery and invocation from your development environment.

API Resources

REST API Endpoints

Browse all REST API endpoints

Examples

View code examples and tutorials

User Guide

Full documentation for using xpander

Support & Community

Slack Community

Join our community

Discord

Developer discussions

GitHub

View source code

Overview

REST API - Conversations

REST API - Agents

REST API - Tasks

Agent Workspace

REST API - Knowledge

REST API - Skills

REST API - Workflows

REST API - Custom Functions

REST API - Scheduled Tasks

REST API - Self-Schedules

REST API - Misc

Channels and webhooks

Advanced

REST API

Model Context Protocol

Quick Comparison

Getting Started

REST API

Explore REST API

Model Context Protocol - Expose to Claude & IDEs

Explore MCP Integration

Authentication

Common Use Cases

API Resources

REST API Endpoints

Examples

User Guide

Support & Community

Slack Community

Discord

GitHub

REST API

Model Context Protocol

​Quick Comparison

​Getting Started

​REST API

Explore REST API

​Model Context Protocol - Expose to Claude & IDEs

Explore MCP Integration

​Authentication

​Common Use Cases

​API Resources

REST API Endpoints

Examples

User Guide

​Support & Community

Slack Community

Discord

GitHub

Quick Comparison

Getting Started

REST API

Model Context Protocol - Expose to Claude & IDEs

Authentication

Common Use Cases

API Resources

Support & Community