Dispersl API Documentation

Welcome to the comprehensive Dispersl API documentation. The Dispersl API provides powerful endpoints for managing multi-agent AI workflows, task orchestration, and intelligent code generation.

Overview

The Dispersl API is designed around agentic workflows that enable you to:

Coordinate Multi-Agent Teams: Distribute complex tasks across specialized AI agents
Generate and Test Code: Use AI agents for code generation, testing, and documentation
Manage Tasks and Steps: Track and control the lifecycle of development tasks
Monitor Performance: Access analytics and usage statistics
Integrate with Your Stack: Use MCP tools and integrations

Base URL

http://localhost:3001/v1

Authentication

All API endpoints require Bearer token authentication unless otherwise noted.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.dispersl.com/v1/agent/chat

API Categories

Agents 🧠Models 🔐Authentication 📋Tasks 👣Steps 📊Analytics 🛠️Tools 📜History

Quick Start

Get your API key from the authentication endpoint
Choose your model from the available models
Start with a simple chat using the chat agent
Scale up to multi-agent workflows with the plan agent

Response Format

Most agent endpoints return NDJSON (Newline Delimited JSON) streams for real-time updates:

{"status": "processing", "message": "Starting task", "content": "Analyzing requirements..."}
{"status": "processing", "message": "Tool call", "tools": [{"function": {"name": "write_to_file"}}]}
{"status": "complete", "message": "Task completed", "metadata": {"tokens": 1500}}

Rate Limits

Free Tier: 100 requests per hour
Pro Tier: 1,000 requests per hour
Enterprise: Custom limits

Support

Documentation: Browse the detailed endpoint documentation in each section
Community: Join our Discord for community support
Enterprise: Contact us for enterprise support and custom integrations

Quickstart Agents