Discovery API

Unified discovery endpoint for PraisonAI servers

Discovery API

The discovery endpoint provides a unified way to discover all available providers and endpoints on any PraisonAI server.

Overview

Every PraisonAI server exposes /__praisonai__/discovery which returns a JSON document describing:

  • Server name and version
  • Available providers (e.g. agents-api, a2a, a2u — only those the server actually mounts)
  • Available endpoints with their capabilities

When to Use

  • Client discovery: Automatically discover server capabilities
  • Health monitoring: Verify server is running with expected providers
  • Integration: Build clients that adapt to available endpoints

Base URL + Playground

bash
# Start server
praisonai serve unified --host 127.0.0.1 --port 8765

Base URL: http://127.0.0.1:8765

Request

none none

No parameters required.

Example Request

curl
curl http://127.0.0.1:8765/__praisonai__/discovery
Python
import requests

response = requests.get("http://127.0.0.1:8765/__praisonai__/discovery")
discovery = response.json()
print(discovery)
JavaScript
const response = await fetch("http://127.0.0.1:8765/__praisonai__/discovery");
const discovery = await response.json();
console.log(discovery);

Response

ResponseField string

Discovery schema version (e.g., “1.0.0”)

ResponseField string

Server name (e.g., “praisonai-unified”)

ResponseField string

Server version

ResponseField array

List of available providers

Provider object
ResponseField string

Provider type: agents-api, recipe, mcp, tools-mcp, a2a, a2u

ResponseField string

Human-readable provider name

ResponseField string

Provider description

ResponseField array

List of capabilities (e.g., ["invoke", "health"])

ResponseField array

List of available endpoints

Endpoint object
ResponseField string

Endpoint name

ResponseField string

Endpoint description

ResponseField string

Provider type this endpoint belongs to

ResponseField array

Streaming modes: ["none"], ["sse"], ["websocket"]

Example Response

json
{
  "schema_version": "1.0.0",
  "server_name": "praisonai-unified",
  "server_version": "1.0.0",
  "providers": [
    {
      "type": "agents-api",
      "name": "Agents API",
      "capabilities": ["invoke"]
    },
    {
      "type": "a2a",
      "name": "A2A Protocol",
      "capabilities": ["agent-card", "message-send"]
    },
    {
      "type": "a2u",
      "name": "A2U Event Stream",
      "capabilities": ["subscribe", "stream"]
    }
  ],
  "endpoints": [
    {
      "name": "agents",
      "description": "Agents workflow endpoint",
      "provider_type": "agents-api"
    },
    {
      "name": "events",
      "description": "Agent event stream",
      "provider_type": "a2u",
      "streaming": ["sse"]
    }
  ]
}

Errors

StatusDescription
200Success
500Server error

CLI Equivalent

bash
# List endpoints from a server
praisonai endpoints list --url http://127.0.0.1:8765

# Get discovery document
praisonai endpoints discovery --url http://127.0.0.1:8765

# Filter by provider type
praisonai endpoints list --url http://127.0.0.1:8765 --type agents-api

Configuration

The discovery document is automatically generated based on the server type:

Server TypeProviders Included
unifiedAll providers
agentsagents-api
reciperecipe
mcpmcp
toolstools-mcp
a2aa2a
a2ua2u

Notes

  • Discovery is always available at /__praisonai__/discovery
  • No authentication required for discovery endpoint
  • Use discovery to build adaptive clients
  • Schema version follows semver

Related