Skip to main content
Every ClarkOS agent exposes a REST API for monitoring, control, and integration.

Base URL

Authentication

Protected endpoints require a Bearer token:
Tokens are configured via environment variables:
  • TICK_TOKEN - For tick execution
  • WRITE_TOKEN - For write operations

Response Format

All responses are JSON:
Or on error:

Rate Limits

Default rate limits:
  • Read endpoints: 100 requests/minute
  • Write endpoints: 20 requests/minute
  • Tick endpoint: 12 requests/minute

Endpoints Overview

State & Health

MethodPathDescription
GET/healthHealth check
GET/stateCurrent agent state
GET/logsActivity logs

Memory

MethodPathDescription
GET/memoriesQuery memories
GET/memories/coreCore memories
GET/memories/statsMemory statistics
POST/memories/storeStore a memory

Consciousness

MethodPathDescription
GET/consciousness/thoughtsRecent thoughts
GET/consciousness/brilliantBrilliant moments
POST/consciousness/processGenerate thought

Control

MethodPathDescription
POST/tickTrigger a tick
POST/wakeWake the agent
POST/feedApply a feed event

Knowledge

MethodPathDescription
GET/knowledgeQuery knowledge
POST/knowledgeAdd knowledge item

Quick Examples

Check Health

Get Current State

Trigger a Tick

Query Memories

WebSocket Subscriptions

For real-time updates, use Convex’s subscription system:

Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing token
RATE_LIMITEDToo many requests
NOT_FOUNDResource not found
VALIDATION_ERRORInvalid parameters
INTERNAL_ERRORServer error

Next Steps

State API

State and logs endpoints.

Memory API

Memory system endpoints.