API Reference

The ForbocAI SDK API provides RESTful endpoints for managing AI agents, local inference, memory, and more. This reference documents all available endpoints.

Base URL

Production: https://api.forbocai.com/v1
Local Dev:  http://localhost:3001/v1

Authentication

API requests require a bearer token in the Authorization header:

$
curl -X POST https://api.forbocai.com/v1/agents \
>
  -H "Authorization: Bearer YOUR_API_KEY" \
>
  -H "Content-Type: application/json" \
>
  -d '{"cortexId": "ctx_abc123", "persona": "A helpful assistant"}'

API Categories

Response Format

All API responses follow a consistent JSON format:

1
{
2
  "id": "agt_123abc",
3
  "object": "agent",
4
  "created": 1706572800,
5
  "data": { ... }
6
}

Error Handling

Errors return appropriate HTTP status codes with details:

1
{
2
  "error": {
3
    "code": "ITEM_NOT_IN_INVENTORY",
4
    "message": "Agent does not possess the item 'legendary_sword'",
5
    "details": {
6
      "item": "legendary_sword",
7
      "agentInventory": ["rusty_key", "healing_potion"]
8
    }
9
  }
10
}

Rate Limits

SDKs

Official SDK libraries wrap this API for common platforms:

$
# JavaScript/TypeScript
$
npm install forbocai
$
$
# Python
$
pip install forbocai
$
$
# Rust
$
cargo add forbocai