REST API - xpander.ai

Base URL https://api.xpander.ai, JSON in and out, one of three credentials on every request (below). Everything Xpander Chat does, from creating an agent to reading a task’s execution log, is an endpoint here.

Overview

The REST API is how your own systems drive agents on xpander. It lets you:

Manage Agents: Create, update, deploy, and delete AI agents
Agent Workspace: Run bash commands, edit files, search code, and share artifacts inside a per-agent workspace
Workflows: Create and run workflow definitions
Skills: Connect to external services, search and manage operations
Custom Functions: Create, generate, and execute user-defined Python skills
Export & Import: Share agents as templates across organizations
Execute Tasks: Invoke agents and workflows synchronously, asynchronously, or with streaming
Control Knowledge: Manage knowledge bases and documents
LLM Providers: Discover available LLM providers and models

Base URL

https://api.xpander.ai

Authentication

Every request must carry one of these credentials:

x-api-key: <api-key>: an xpander API key. The examples on these pages use this header.
Authorization: Bearer <jwt>: an OAuth 2.1 access token issued by xpander’s authorization server.
Authorization: Basic <base64 api-key>: the same API key, base64-encoded, for clients that only speak Basic auth.

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

API keys come in two kinds. A personal key is tied to your user: an agent created with it is owned by your user, and it reaches the agents you can see. An organization key acts for the organization; an admin can limit which agents it may reach. Your organization’s admin invites you to xpander and manages keys under Settings. A personal key also reaches your own Omni, the built-in agent: Get Omni Agent returns its id.

Quick Start

# List all 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"
    }
  }'

import requests

API_KEY = "your-api-key"
BASE_URL = "https://api.xpander.ai/v1"

# List all agents
response = requests.get(
    f"{BASE_URL}/agents",
    headers={"x-api-key": API_KEY}
)
agents = response.json()

# Invoke an agent
response = requests.post(
    f"{BASE_URL}/agents/{agent_id}/invoke",
    headers={"x-api-key": API_KEY},
    json={"input": {"text": "Analyze this data"}}
)
result = response.json()

const API_KEY = 'your-api-key';
const BASE_URL = 'https://api.xpander.ai/v1';

// List all agents
const agents = await fetch(`${BASE_URL}/agents`, {
  headers: { 'x-api-key': API_KEY }
}).then(r => r.json());

// Invoke an agent
const result = await fetch(`${BASE_URL}/agents/${agentId}/invoke`, {
  method: 'POST',
  headers: {
    'x-api-key': API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    input: { text: 'Analyze this data' }
  })
}).then(r => r.json());

API Endpoints

Agents

Create, manage, and invoke AI agents

Agent Workspace

Run commands, edit files, and share artifacts in a per-agent workspace

Workflows

Create and run workflow definitions

Skills

Discover skills, connect, inspect operation schemas, and invoke operations

Custom Functions

Create and execute user-defined Python skills

Tasks

Monitor and manage task executions

Knowledge

Manage knowledge bases and documents

LLM Providers

Discover available LLM providers and models

Errors

A 422 names the field that failed validation, in FastAPI’s shape:

{
  "detail": [
    {
      "loc": ["body", "input"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

Next Steps

Agent Endpoints

Explore agent management endpoints

Workflow Endpoints

Create and run workflows

Examples

View code examples

OpenAPI Spec

Download OpenAPI specification

​Overview

​Base URL

​Authentication

​Quick Start

​API Endpoints