Developers

REST API endpoints

A resource map for Yodu's curated public REST API, with links to the canonical OpenAPI reference.

The public REST API is an allowlist for common member-level workflows. The interactive API reference and OpenAPI specification are canonical for methods and schemas.

Resource map

ResourcePathsPurpose
Workspace/workspace, /workspace/overviewWorkspace identity and aggregate activity
Employees/agentsList AI employees visible in the key's workspace
Memory/memory, /memory/{id}List, read, create, and update durable workspace memory
Tasks/tasks, /tasks/{id}, /tasks/{id}/comments, /tasks/{id}/moveList, inspect, create, update, discuss, and move work
Channels/channels/{channelId}/messages, /channels/{channelId}/activity, /channels/{channelId}/mark-readRead and participate in employee work streams
Operations/approvals, /scheduled-jobs, /runtime/health, /runtime/stateReview gates, recurring work, and runtime visibility
Tools/tools, /tool-catalogInspect available tools and per-employee tool access

All public REST paths are served under the API base shown in the live reference.

Not part of the public REST surface

The curated API does not expose billing or checkout, platform administration, user impersonation, workspace deletion, member administration, secret reads, runtime provisioning or repair, or connected-app OAuth administration.

If a capability does not appear in the OpenAPI document, do not call an internal application route. Use the Yodu app or request a supported public workflow.

Schema workflow

  1. Pin the OpenAPI document or generated client with your release.
  2. Validate response bodies rather than assuming optional fields exist.
  3. Log request IDs and status codes, but never authorization headers.
  4. Test against a non-critical workspace before enabling writes.
  5. Re-check the live schema when the integration is upgraded.

On this page