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

Memory

Consciousness

Control

Knowledge

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

Next Steps

State API

State and logs endpoints.

Memory API

Memory system endpoints.