API Reference

HTTP API endpoints for PraisonAI services

API Reference

This section documents all HTTP API endpoints exposed by PraisonAI packages.

Deploy APIs

Server endpoints for deployed agents. See Deploy for setup guides.

Agents API

HTTP REST endpoints for agent servers

MCP API

Model Context Protocol endpoints

A2A API

Agent-to-Agent protocol endpoints

AGUI API

AG-UI protocol for CopilotKit

Other APIs

Voice Call API

Twilio voice integration with OpenAI Realtime

Async Jobs API

Background job execution endpoints

Base URLs

Service	Default URL
Agents Server	`http://localhost:8000/{path}`
MCP Server	`http://localhost:8080/sse`
A2A Server	`http://localhost:8000/a2a`
AGUI Server	`http://localhost:8000/agui`

Quick Test

bash

# Health check
curl http://localhost:8000/health

# Send query
curl -X POST http://localhost:8000/ask \
  -H "Content-Type: application/json" \
  -d '{"query": "Hello"}'

Error Responses

json

{
  "detail": "Error message"
}

Status	Description
`400`	Bad request
`401`	Unauthorized
`404`	Not found
`500`	Server error