Feature capabilities

Choose an area to find routes and required roles. Counts and methods come from the OpenAPI contract; the notes explain their purpose. Check your server version and configuration for availability.

Roles are the contract's own x-required-roles. Credentials carry a namespace and a principal; admin implies every role, and an operation marked "no credentials" is unauthenticated. A role is necessary, not sufficient: the server also enforces ownership.

Generated route counts cover JSON request/response operations. The public Python SDK also provides Client.events(traverser_id) for SSE streaming and reconnection.

Area	Operations	Methods	Roles	Generated Python client
Access	12	DELETE, GET, PATCH, POST, PUT	admin, invoke, worker	12/12
Admin	2	DELETE, POST	worker	2/2
Approvals	4	GET, POST	invoke, worker	4/4
Artifacts	8	DELETE, GET, POST	invoke, worker	8/8
Auth	4	DELETE, GET, POST	admin	4/4
Budgets	7	DELETE, GET, PATCH, POST	invoke	7/7
Checkpoints	3	GET, POST	invoke, worker	3/3
Credentials	14	GET, POST, PUT	admin, invoke, worker	14/14
Discovery	8	DELETE, GET, POST	admin, invoke	8/8
Emitters	10	DELETE, GET, PATCH, POST	admin, invoke	10/10
Evaluations	14	DELETE, GET, PATCH, POST	invoke	14/14
Events	3	GET	invoke, worker	2/3
Health	1	GET	public	1/1
Identity	7	GET, POST	admin, invoke	7/7
Knowledge	7	POST	invoke, worker	7/7
Memory	9	POST	invoke, worker	9/9
Observability	19	DELETE, GET, PATCH, POST, PUT	admin, invoke, worker	19/19
Retention	2	POST	admin	2/2
RuntimeSettings	5	DELETE, GET, POST, PUT	invoke	5/5
Sessions	7	DELETE, GET, POST, PUT	invoke, worker	7/7
Traversers	6	GET, POST	invoke	6/6
Worker	10	GET, POST	invoke, worker	10/10

Access

Set the server's access policies and connector grants. Use these rules to restrict which capabilities and API operations a principal may use.

POST /api/v2/access/admit — admitAccess
GET /api/v2/access/connector — getOwnConnector
GET /api/v2/access/connectors — listConnectors
GET /api/v2/access/connectors/{principal} — getConnector
PUT /api/v2/access/connectors/{principal} — putConnector
POST /api/v2/access/connectors/{principal}/revoke — revokeConnector
POST /api/v2/access/evaluate — evaluateAccess
GET /api/v2/access/policies — listAccessPolicies
POST /api/v2/access/policies — createAccessPolicy
GET /api/v2/access/policies/{id} — getAccessPolicy
PATCH /api/v2/access/policies/{id} — updateAccessPolicy
DELETE /api/v2/access/policies/{id} — deleteAccessPolicy

Admin

POST /api/v2/agents — registerAgent
DELETE /api/v2/agents/{label} — unregisterAgent

Approvals

Save review requests, list waiting approvals and record an authorized decision.

GET /api/v2/approvals — listApprovals
POST /api/v2/approvals — requestApproval
GET /api/v2/approvals/{id} — getApproval
POST /api/v2/approvals/{id}/decide — decideApproval

Artifacts

Upload, list, download and delete files associated with a traverser.

GET /api/v2/artifacts/{id} — getArtifact
DELETE /api/v2/artifacts/{id} — deleteArtifact
GET /api/v2/sessions/{id}/artifacts — listBriefArtifacts
POST /api/v2/sessions/{id}/artifacts — putBriefArtifact
GET /api/v2/sessions/{id}/artifacts/{artifact_id} — getBriefArtifact
DELETE /api/v2/sessions/{id}/artifacts/{artifact_id} — deleteBriefArtifact
GET /api/v2/traversers/{id}/artifacts — listArtifacts
POST /api/v2/traversers/{id}/artifacts — putArtifact

Auth

Operations grouped under this contract tag.

GET /api/v2/auth/tokens — listApiTokens
POST /api/v2/auth/tokens — createApiToken
DELETE /api/v2/auth/tokens/{id} — revokeApiToken
POST /api/v2/auth/tokens/{id}/rotate — rotateApiToken

Budgets

Operations grouped under this contract tag.

GET /api/v2/budgets — listBudgets
POST /api/v2/budgets — createBudget
GET /api/v2/budgets/status — budgetStatus
GET /api/v2/budgets/{id} — getBudget
PATCH /api/v2/budgets/{id} — updateBudget
DELETE /api/v2/budgets/{id} — deleteBudget
GET /api/v2/budgets/{id}/usage — budgetUsage

Checkpoints

Save named, revisioned values so a handler can reuse work when it starts again.

GET /api/v2/traversers/{id}/checkpoints — listCheckpoints
GET /api/v2/traversers/{id}/checkpoints/{name} — getCheckpoint
POST /api/v2/traversers/{id}/checkpoints/{name} — writeCheckpoint

Credentials

Enroll node identities, issue and verify credentials, revoke them and manage node tags. Signing keys remain on the server.

GET /api/v2/credentials — listCredentials
POST /api/v2/credentials — issueCredential
GET /api/v2/credentials/dids — listDids
POST /api/v2/credentials/dids — enrolDid
POST /api/v2/credentials/dids/resolve — resolveDid
GET /api/v2/credentials/dids/{label} — getDid
GET /api/v2/credentials/tags — listTagLedger
POST /api/v2/credentials/tags — proposeTags
POST /api/v2/credentials/tags/decide — decideTags
GET /api/v2/credentials/tags/policy — getTagPolicy
PUT /api/v2/credentials/tags/policy — putTagPolicy
POST /api/v2/credentials/verify — verifyCredential
GET /api/v2/credentials/{id} — getCredential
POST /api/v2/credentials/{id}/revoke — revokeCredential

Discovery

Inspect the server and registered capabilities. Manage and search discovery publications under /api/v2/ard.

GET /api/v2/agents — listAgents
GET /api/v2/agents/{label}/capabilities — agentCapabilities
GET /api/v2/ard/publications — listPublications
POST /api/v2/ard/publications — publishDiscovery
DELETE /api/v2/ard/publications/{id} — deletePublication
POST /api/v2/ard/search — searchDiscovery
GET /api/v2/ard/settings — discoverySettings
GET /api/v2/server — serverInfo

Emitters

Configure schedules and inbound events that start work; inspect and replay deliveries.

POST /api/v2/agents/{label}/emitters — syncEmitters
GET /api/v2/emitters — listEmitters
POST /api/v2/emitters — createEmitter
GET /api/v2/emitters/metrics — emitterMetrics
GET /api/v2/emitters/{id} — getEmitter
PATCH /api/v2/emitters/{id} — updateEmitter
DELETE /api/v2/emitters/{id} — deleteEmitter
GET /api/v2/emitters/{id}/events — emitterEvents
POST /api/v2/emitters/{id}/fire — fireEmitter
POST /api/v2/emitters/{id}/replay — replayEmitterEvent

Evaluations

Operations grouped under this contract tag.

GET /api/v2/evals/case-sets — listEvalCaseSets
POST /api/v2/evals/case-sets — createEvalCaseSet
GET /api/v2/evals/case-sets/{id} — getEvalCaseSet
PATCH /api/v2/evals/case-sets/{id} — updateEvalCaseSet
DELETE /api/v2/evals/case-sets/{id} — deleteEvalCaseSet
GET /api/v2/evals/case-sets/{id}/cases — listEvalCases
POST /api/v2/evals/case-sets/{id}/cases — createEvalCase
POST /api/v2/evals/case-sets/{id}/run — startEvalRun
GET /api/v2/evals/case-sets/{id}/scores — evalScores
PATCH /api/v2/evals/cases/{id} — updateEvalCase
DELETE /api/v2/evals/cases/{id} — deleteEvalCase
GET /api/v2/evals/runs — listEvalRuns
GET /api/v2/evals/runs/{id} — getEvalRun
POST /api/v2/evals/runs/{id}/cancel — cancelEvalRun

Events

Read stored traversal events or follow progress through an event stream.

GET /api/v2/logs/events — streamNodeLogs
GET /api/v2/traversers/{id}/event-log — getEventLog
GET /api/v2/traversers/{id}/events — streamExecutionEvents

Not exposed by the generated Python client modules: streamExecutionEvents.

Health

Check whether the server process responds, without credentials.

GET /health — health

Identity

Manage node signing identities, sign recorded paths and verify proofs.

GET /api/v2/identities — listIdentities
POST /api/v2/identities — createIdentity
POST /api/v2/identities/{id}/revoke — revokeIdentity
POST /api/v2/identities/{id}/rotate — rotateIdentity
POST /api/v2/proofs/verify — verifyProof
GET /api/v2/traversers/{id}/proofs — listPathProofs
POST /api/v2/traversers/{id}/sign — signPath

Knowledge

Store scoped documents, retrieve chunks with BM25 scores and citations, and inspect collection statistics.

POST /api/v2/knowledge/delete — deleteKnowledgeDocument
POST /api/v2/knowledge/get — getKnowledgeDocument
POST /api/v2/knowledge/list — listKnowledgeDocuments
POST /api/v2/knowledge/put — putKnowledgeDocument
POST /api/v2/knowledge/put-batch — putKnowledgeBatch
POST /api/v2/knowledge/search — searchKnowledge
POST /api/v2/knowledge/stats — knowledgeStats

Memory

Read and update state in session, actor, workflow or global scope.

POST /api/v2/memory/changes — memoryChanges
POST /api/v2/memory/delete — deleteMemory
POST /api/v2/memory/list — listMemory
POST /api/v2/memory/read — readMemory
POST /api/v2/memory/vector/delete — deleteMemoryVector
POST /api/v2/memory/vector/get — getMemoryVector
POST /api/v2/memory/vector/search — searchMemoryVectors
POST /api/v2/memory/vector/set — setMemoryVector
POST /api/v2/memory/write — writeMemory

Observability

Read usage, logs, run metadata, server counts and model health. Configure the outbound observability webhook to notify another service.

GET /api/v2/logs — queryLogs
POST /api/v2/logs — appendLogs
GET /api/v2/model-health — modelHealth
GET /api/v2/observability/settings — getObservabilitySettings
PATCH /api/v2/observability/settings — updateObservabilitySettings
GET /api/v2/observability/webhook — getObservabilityWebhook
PUT /api/v2/observability/webhook — putObservabilityWebhook
DELETE /api/v2/observability/webhook — deleteObservabilityWebhook
POST /api/v2/observability/webhook/redrive — redriveObservabilityWebhook
GET /api/v2/observability/webhook/status — observabilityWebhookStatus
POST /api/v2/observability/webhook/test — testObservabilityWebhook
POST /api/v2/retrieval/feedback — recordRetrievalFeedback
POST /api/v2/retrieval/feedback/totals — retrievalFeedbackTotals
GET /api/v2/stats — stats
GET /api/v2/traversers/{id}/metadata — getRunMetadata
PATCH /api/v2/traversers/{id}/metadata — updateRunMetadata
GET /api/v2/usage — listUsage
POST /api/v2/usage — recordUsage
GET /api/v2/usage/totals — usageTotals

Retention

Preview records selected by retention rules, then apply pruning.

POST /api/v2/retention/apply — retentionApply
POST /api/v2/retention/plan — retentionPlan

RuntimeSettings

Manage namespace settings documents. Save changes first, then apply them separately when they should affect the running process.

GET /api/v2/runtime/settings — listRuntimeSettings
GET /api/v2/runtime/settings/{key} — getRuntimeSettings
PUT /api/v2/runtime/settings/{key} — putRuntimeSettings
DELETE /api/v2/runtime/settings/{key} — deleteRuntimeSettings
POST /api/v2/runtime/settings/{key}/apply — applyRuntimeSettings

Sessions

Create sessions for related runs and bind worker tasks to their shared session.

GET /api/v2/sessions — listSessions
POST /api/v2/sessions — createSession
GET /api/v2/sessions/{id} — getSession
DELETE /api/v2/sessions/{id} — deleteSession
GET /api/v2/sessions/{id}/secrets — getSessionSecrets
PUT /api/v2/sessions/{id}/secrets — putSessionSecrets
DELETE /api/v2/sessions/{id}/secrets — deleteSessionSecrets

Traversers

Submit work, filter and page through runs, inspect results and paths, cancel or restart a run.

GET /api/v2/traversers — listTraversers
POST /api/v2/traversers — submitTraverser
GET /api/v2/traversers/{id} — getTraverser
POST /api/v2/traversers/{id}/cancel — cancelTraverser
GET /api/v2/traversers/{id}/path — getPath
POST /api/v2/traversers/{id}/restart — restartTraverser

Worker

Enroll outbound workers, claim and renew tasks, report progress/results and drain. Operators can also inspect the enrolled fleet.

POST /api/v2/sessions/bind — bindSession
POST /api/v2/worker/claim — claimTask
POST /api/v2/worker/complete — completeTask
POST /api/v2/worker/drain — drainWorker
POST /api/v2/worker/enroll — enrollWorker
POST /api/v2/worker/progress — reportProgress
POST /api/v2/worker/renew — renewLease
POST /api/v2/worker/resume — resumeTask
POST /api/v2/worker/suspend — suspendTask
GET /api/v2/workers — listWorkers