Skip to main content

Actx0 REST API

Actx0 exposes a versioned HTTP API under /api/v1. Use it to run agents and sessions, store messages and memories, version prompts, and search knowledge documents. Examples are in Pctx0 (Python), Nctx0 (Node.js), Gtcx0 (Go), and cURL / Acli. Create, list, update, and delete workspaces with a user API key (X-API-Key). Everything else in this guide uses a workspace access key (X-Access-Key).
Quick start: Create a workspace access key in the Actx0 Dashboard, then call Create Memory with X-Access-Key.

SDKs and CLI

These clients authenticate with a workspace access key (X-Access-Key). Create workspaces and access keys in the Actx0 Dashboard.

Base URL


Authentication

Most API requests authenticate with a workspace access key:
Create access keys in the Actx0 Dashboard with the permissions your agents need. Agents, sessions, messages, memories, prompts, and knowledge accept the key when it includes the matching permission. Create Workspace and other workspace CRUD endpoints require a user API key instead:
Keep your keys secure. Never expose them in client-side code or public repositories. Use environment variables and server-side requests only.

Resource hierarchy

Sessions can also be addressed by external id and/or label query params via /sessions/by-labels.

Conventions

  • IDs are UUIDs.
  • Timestamps are RFC3339 UTC strings.
  • Pagination uses limit (default 50, max 100) and offset (default 0).
  • List responses use a collection key plus _meta:
  • meta fields on messages/memories: send a JSON string in requests; responses return parsed JSON.
  • Errors always look like:

Core memory loop

  1. Create a workspace access key in the Actx0 Dashboard
  2. Create Agent — create an agent in the workspace
  3. Create Session — open a conversation session
  4. Create Memory — store facts and preferences
  5. Search Memories — retrieve relevant context

API categories

Me

Inspect the authenticated access key or API key

Workspaces

Create, list, update, and delete workspaces

Agents

Create and manage agents in a workspace

Sessions

Agent conversation sessions and labels

Messages

Session messages with semantic search

Memories

Session memory CRUD, search, and batch

Prompts

Versioned prompts and production labels

Knowledge

Document upload and semantic search