SYMBI API Documentation

Complete API reference for integrating with the SYMBI ecosystem. Build agents, manage trust receipts, and access quality metrics.

AgentVerse API Tactical Command API SYMBI-Synergy API SYMBI-Resonate API

Quick Start

Authentication

All API requests require authentication using API keys. Include your key in the Authorization header:

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     https://api.symbi.ai/v1/agents

Base URLs

AgentVerse

https://agentverse.symbi.ai/api/v1

Tactical Command

https://tactical.symbi.ai/api/v1

SYMBI-Synergy

https://synergy.symbi.ai/api/v1

AgentVerse API

Create, manage, and orchestrate AI agents with multi-LLM support and constitutional protocols.

POST/agents

Create a new AI agent with specified configuration and constitutional constraints.

Parameters

Name	Type	Required	Description
name	string	Required	Unique name for the agent
model	string	Required	LLM model (gpt-4, claude-3, gemini-pro)
constitution	object	Required	Constitutional AI constraints and principles
capabilities	array	Optional	List of enabled capabilities

Response

Returns the created agent object with ID, configuration, and status.

Example

bash

curl -X POST https://agentverse.symbi.ai/api/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "research-assistant",
    "model": "gpt-4",
    "constitution": {
      "principles": ["accuracy", "transparency", "safety"],
      "constraints": ["no-harmful-content", "cite-sources"]
    },
    "capabilities": ["web-search", "document-analysis"]
  }'

GET/agents/{agent_id}/simulate

Run a simulation with the specified agent and return detailed interaction logs.

Parameters

Name	Type	Required	Description
agent_id	string	Required	ID of the agent to simulate
scenario	string	Required	Simulation scenario description
steps	integer	Optional	Number of simulation steps (default: 10)

Response

Returns simulation results with step-by-step logs, quality metrics, and trust receipts.

Example

bash

curl "https://agentverse.symbi.ai/api/v1/agents/agent_123/simulate?scenario=research-task&steps=5" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/agents

List all agents with optional filtering by status, model, or capabilities.

Parameters

Name	Type	Required	Description
status	string	Optional	Filter by status (active, inactive, training)
model	string	Optional	Filter by LLM model
limit	integer	Optional	Maximum number of results (default: 50)

Response

Returns paginated list of agents with basic information and status.

Example

bash

curl "https://agentverse.symbi.ai/api/v1/agents?status=active&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Tactical Command Interface API

Operations dashboard with RAG capabilities, agent management, and real-time monitoring.

POST/rag/retrieve

Retrieve relevant documents using vector similarity search with embedded queries.

Parameters

Name	Type	Required	Description
query	string	Required	Search query to embed and match
limit	integer	Optional	Maximum number of results (default: 10)
threshold	float	Optional	Similarity threshold (0.0-1.0)
collection	string	Optional	Specific document collection to search

Response

Returns array of relevant document chunks with similarity scores and metadata.

Example

bash

curl -X POST https://tactical.symbi.ai/api/v1/rag/retrieve \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "constitutional AI safety protocols",
    "limit": 5,
    "threshold": 0.7
  }'

POST/agents/register

Parameters

Name	Type	Required	Description
manifest	object	Required	Agent manifest with capabilities and configuration
endpoint	string	Required	Agent's API endpoint for communication
auth_token	string	Optional	Authentication token for agent communication

Response

Returns registration confirmation with assigned agent ID and monitoring setup.

Example

bash

curl -X POST https://tactical.symbi.ai/api/v1/agents/register \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "manifest": {
      "name": "data-analyst",
      "version": "1.0.0",
      "capabilities": ["data-processing", "visualization"]
    },
    "endpoint": "https://my-agent.example.com/api"
  }'

POST/messages/send

Send a message through the tactical command message bus to connected agents.

Parameters

Name	Type	Required	Description
recipient	string	Required	Target agent ID or broadcast channel
message	object	Required	Message payload with type and content
priority	string	Optional	Message priority (low, normal, high, urgent)

Response

Returns message delivery confirmation with tracking ID and delivery status.

Example

bash

curl -X POST https://tactical.symbi.ai/api/v1/messages/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recipient": "agent_456",
    "message": {
      "type": "task_assignment",
      "content": "Analyze quarterly sales data"
    },
    "priority": "high"
  }'

SYMBI-Synergy API

Enterprise trust receipt management, compliance dashboards, and cryptographic audit trails.

POST/receipts

Create a new trust receipt for an AI interaction with cryptographic signing.

Parameters

Name	Type	Required	Description
session_id	string	Required	Unique session identifier
agent_id	string	Required	ID of the agent that performed the interaction
interaction	object	Required	Details of the AI interaction
ciq_score	float	Optional	Constitutional Intelligence Quotient score
metadata	object	Optional	Additional metadata for the receipt

Response

Returns the created trust receipt with cryptographic signature and hash chain.

Example

bash

curl -X POST https://synergy.symbi.ai/api/v1/receipts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_id": "sess_789",
    "agent_id": "agent_123",
    "interaction": {
      "query": "Summarize financial report",
      "response": "Q3 revenue increased 15%...",
      "timestamp": "2024-01-15T10:30:00Z"
    },
    "ciq_score": 0.92
  }'

GET/receipts/{receipt_id}/verify

Verify the cryptographic integrity and authenticity of a trust receipt.

Parameters

Name	Type	Required	Description
receipt_id	string	Required	ID of the receipt to verify
include_chain	boolean	Optional	Include full hash chain verification

Response

Returns verification status with signature validation and chain integrity results.

Example

bash

curl "https://synergy.symbi.ai/api/v1/receipts/receipt_456/verify?include_chain=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

GET/compliance/dashboard

Get compliance dashboard data with metrics, alerts, and audit summaries.

Parameters

Name	Type	Required	Description
timeframe	string	Optional	Time period (24h, 7d, 30d, 90d)
agent_filter	string	Optional	Filter by specific agent ID
include_details	boolean	Optional	Include detailed breakdown

Response

Returns comprehensive compliance metrics, violation alerts, and audit trail summaries.

Example

bash

curl "https://synergy.symbi.ai/api/v1/compliance/dashboard?timeframe=7d&include_details=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

SYMBI-Resonate API

AI behavior assessment, Constitutional Intelligence Quotient (CIQ) scoring, and quality metrics.

POST/assess

Assess AI behavior and calculate Constitutional Intelligence Quotient (CIQ) score.

Parameters

Name	Type	Required	Description
interaction	object	Required	AI interaction to assess
constitution	object	Required	Constitutional principles to evaluate against
context	object	Optional	Additional context for assessment

Response

Returns detailed assessment with CIQ score, principle adherence, and quality metrics.

Example

bash

curl -X POST https://symbi-resonate.ai/api/v1/assess \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "interaction": {
      "query": "How should I handle sensitive data?",
      "response": "Always encrypt sensitive data...",
      "agent_id": "agent_123"
    },
    "constitution": {
      "principles": ["privacy", "security", "transparency"]
    }
  }'

GET/metrics/{agent_id}

Get comprehensive quality metrics and historical CIQ scores for a specific agent.

Parameters

Name	Type	Required	Description
agent_id	string	Required	ID of the agent to analyze
timeframe	string	Optional	Time period for metrics (24h, 7d, 30d)
include_trends	boolean	Optional	Include trend analysis

Response

Returns agent quality metrics, CIQ score history, and performance trends.

Example

bash

curl "https://symbi-resonate.ai/api/v1/metrics/agent_123?timeframe=30d&include_trends=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/benchmark

Run a comprehensive benchmark assessment against standard constitutional AI protocols.

Parameters

Name	Type	Required	Description
agent_id	string	Required	Agent to benchmark
benchmark_suite	string	Optional	Specific benchmark suite (standard, enterprise, research)
scenarios	array	Optional	Custom scenarios to include

Response

Returns detailed benchmark results with scores, comparisons, and recommendations.

Example

bash

curl -X POST https://symbi-resonate.ai/api/v1/benchmark \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "agent_123",
    "benchmark_suite": "enterprise",
    "scenarios": ["ethical-dilemma", "privacy-handling"]
  }'

SDKs and Libraries

Python SDK

bash

pip install symbi-sdk

# Usage example
from symbi import AgentVerse, TacticalCommand

# Initialize clients
agentverse = AgentVerse(api_key="your_key")
tactical = TacticalCommand(api_key="your_key")

# Create an agent
agent = agentverse.create_agent(
    name="research-assistant",
    model="gpt-4",
    constitution={
        "principles": ["accuracy", "transparency"]
    }
)

# Register with tactical command
tactical.register_agent(agent.id, agent.manifest)

TypeScript SDK

bash

npm install @symbi/sdk

// Usage example
import { AgentVerse, TacticalCommand } from '@symbi/sdk';

// Initialize clients
const agentverse = new AgentVerse({ apiKey: 'your_key' });
const tactical = new TacticalCommand({ apiKey: 'your_key' });

// Create an agent
const agent = await agentverse.createAgent({
  name: 'research-assistant',
  model: 'gpt-4',
  constitution: {
    principles: ['accuracy', 'transparency']
  }
});

// Register with tactical command
await tactical.registerAgent(agent.id, agent.manifest);

Error Handling

HTTP Status Codes

200 OK

Request successful

201 Created

Resource created successfully

400 Bad Request

Invalid request parameters

401 Unauthorized

Invalid or missing API key

429 Too Many Requests

Rate limit exceeded

Error Response Format

json

{
  "error": {
    "code": "INVALID_AGENT_CONFIG",
    "message": "Agent configuration is invalid",
    "details": {
      "field": "constitution.principles",
      "issue": "At least one principle is required"
    },
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Rate Limits

Free Tier

1,000

requests per hour

Pro Tier

10,000

requests per hour

Enterprise

Custom

contact sales

Rate limit headers are included in all responses: X-RateLimit-Limit,X-RateLimit-Remaining, and X-RateLimit-Reset.

Need Help?

Our developer community and support team are here to help you build amazing applications with SYMBI.

Join Discord GitHub Issues Email Support