Skip to main content

Creatoria Agent API Documentation

Creatoria Agent API Documentation

#Creatoria Agent API Documentation

Welcome to the Creatoria Agent API. Build, deploy, and manage AI-powered agents with knowledge bases, custom tools, webhooks, and more.

#Basic Information

ItemDescription
Base URLhttps://your-domain.com/v1
ProtocolHTTPS
AuthenticationAPI Key (X-API-Key header)
Project ContextX-Project-Id header (optional)
Response FormatJSON
VersioningURI versioning (/v1/)

#Unified Response Format

All list endpoints return a paginated response:

json{
  "data": [ ... ],
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "totalPages": 5,
    "hasNext": true,
    "hasPrev": false
  }
}

#API Catalog

#Getting Started

DocumentDescription
Quick Start5-minute quick start guide
AuthenticationAPI Key authentication and permissions

#Core APIs

DocumentBase PathDescription
Agents API/v1/agentsAgent creation, management, and configuration
Chat API/v1/agents/:id/chatChat with agents, streaming and non-streaming
Agentic Streaming/v1/agents/:id/chatThinking chains, planning, tool calls

#Data & Knowledge

DocumentBase PathDescription
Knowledge Base API/v1/knowledge-basesKnowledge base management and RAG

#Tools & Extensions

DocumentBase PathDescription
Tools Configuration API/v1/tools/configurationsBuilt-in tool configuration and usage
Custom Tools API/v1/custom-toolsHTTP webhook and JS sandbox custom tools

#Integrations

DocumentBase PathDescription
Webhooks API/v1/webhooksWebhook event subscriptions and delivery
SDK Quickstart-JavaScript, Python, and cURL examples

#Reference

DocumentDescription
Error HandlingError codes and best practices
Rate LimitsRequest rate limits and quotas

#Quick Examples

#cURL

bash# List all Agents
curl -X GET "https://your-domain.com/v1/agents" \
  -H "X-API-Key: your-api-key" \
  -H "X-Project-Id: your-project-id"

#JavaScript / TypeScript

javascriptconst response = await fetch('https://your-domain.com/v1/agents', {
  headers: {
    'X-API-Key': 'your-api-key',
    'X-Project-Id': 'your-project-id',
  },
});
const { data, meta } = await response.json();
console.log(`Total agents: ${meta.total}`);

#Python

pythonimport requests

resp = requests.get(
    'https://your-domain.com/v1/agents',
    headers={
        'X-API-Key': 'your-api-key',
        'X-Project-Id': 'your-project-id',
    },
)
result = resp.json()
print(f"Total agents: {result['meta']['total']}")

#Key Concepts

#Multi-Tenant Model

Each API Key is bound to an Organization, and data is strictly isolated by organizationId. Use the X-Project-Id header to select a project within the organization.

#Required Headers

HeaderRequiredDescription
X-API-KeyYesAPI Key authentication token
X-Project-IdNoSpecify project context (uses default project if omitted)
Content-TypeFor writesapplication/json

#Streaming

The Chat API supports Server-Sent Events (SSE) streaming. Set stream: true to receive real-time incremental responses, including thinking chains, planning steps, and tool call events.

Next: Quick Start →