Skip to content

API Catalog

The aggregated inventory of representative API endpoints, grouped by platform. All endpoints are versioned under /api/v1, follow the contract-first conventions in Naming Conventions, and are secured with OAuth2 / JWT bearer authentication. Endpoints are REST/JSON unless gRPC is noted. Unless stated otherwise, status is Target (final-state design).

Knowledge Platform

See Knowledge Platform.

API Platform Method & Path Type Auth Status
Semantic search Knowledge POST /knowledge/search/semantic REST OAuth2/JWT Target
Hybrid search Knowledge POST /knowledge/search/hybrid REST OAuth2/JWT Target
Metadata search Knowledge POST /knowledge/search/metadata REST OAuth2/JWT Target
Graph query Knowledge POST /knowledge/graph/query REST OAuth2/JWT Target
Build context Knowledge POST /knowledge/context/build REST OAuth2/JWT Target
Get context package Knowledge GET /knowledge/context/{id} REST OAuth2/JWT Target
Ingest artifact Knowledge POST /knowledge/ingest/artifact REST OAuth2/JWT Target
Ingest repository Knowledge POST /knowledge/ingest/repository REST OAuth2/JWT Target
Ingest documentation Knowledge POST /knowledge/ingest/documentation REST OAuth2/JWT Target
Ingest prompt Knowledge POST /knowledge/ingest/prompt REST OAuth2/JWT Target
Ingest runtime signal Knowledge POST /knowledge/ingest/runtime-signal REST OAuth2/JWT Target
Evaluate access Knowledge POST /knowledge/access/evaluate REST OAuth2/JWT Target
Classify memory Knowledge POST /knowledge/classify REST OAuth2/JWT Target
Redact memory Knowledge POST /knowledge/redact REST OAuth2/JWT Target

Agent Mesh

See Agent Mesh.

API Platform Method & Path Type Auth Status
Register agent Agent Mesh POST /agents/register REST OAuth2/JWT Target
Get agent Agent Mesh GET /agents/{id} REST OAuth2/JWT Target
Register skill Agent Mesh POST /skills/register REST OAuth2/JWT Target
Create agent task Agent Mesh POST /agent-tasks REST OAuth2/JWT Target
Get agent task Agent Mesh GET /agent-tasks/{id} REST OAuth2/JWT Target
Start execution Agent Mesh POST /agent-executions REST OAuth2/JWT Target
Complete execution Agent Mesh POST /agent-executions/{id}/complete REST OAuth2/JWT Target
Fail execution Agent Mesh POST /agent-executions/{id}/fail REST OAuth2/JWT Target
Agent health Agent Mesh GET /agents/{id}/health REST OAuth2/JWT Target

Template & Library Platform

See Template & Library.

API Platform Method & Path Type Auth Status
Create template Template & Library POST /templates REST OAuth2/JWT Target
Get template Template & Library GET /templates/{id} REST OAuth2/JWT Target
Create template version Template & Library POST /templates/{id}/versions REST OAuth2/JWT Target
Execute template Template & Library POST /templates/{id}/execute REST OAuth2/JWT Target
Validate template Template & Library POST /templates/{id}/validate REST OAuth2/JWT Target
Evaluate compatibility Template & Library POST /templates/{id}/compatibility/evaluate REST OAuth2/JWT Target
Create library Template & Library POST /libraries REST OAuth2/JWT Target
Get library Template & Library GET /libraries/{id} REST OAuth2/JWT Target
Search libraries Template & Library POST /libraries/search REST OAuth2/JWT Target
Evaluate library compatibility Template & Library POST /libraries/compatibility/evaluate REST OAuth2/JWT Target

DevOps / GitOps

See DevOps / GitOps.

API Platform Method & Path Type Auth Status
Create repository DevOps POST /repositories REST OAuth2/JWT Target
Create branch DevOps POST /repositories/{id}/branches REST OAuth2/JWT Target
Create commit DevOps POST /repositories/{id}/commits REST OAuth2/JWT Target
Create pull request DevOps POST /pull-requests REST OAuth2/JWT Target
Get pull request DevOps GET /pull-requests/{id} REST OAuth2/JWT Target
Generate pipeline DevOps POST /pipelines/generate REST OAuth2/JWT Target
Run pipeline DevOps POST /pipelines/{id}/run REST OAuth2/JWT Target
Create release DevOps POST /releases REST OAuth2/JWT Target
Approve release DevOps POST /releases/{id}/approve REST OAuth2/JWT Target
Provision IaC DevOps POST /iac/provision REST OAuth2/JWT Target

Observability & Feedback

See Observability & Feedback.

API Platform Method & Path Type Auth Status
Get trace Observability GET /traces/{id} REST OAuth2/JWT Target
Search logs Observability POST /logs/search REST OAuth2/JWT Target
Query metrics Observability POST /metrics/query REST OAuth2/JWT Target
Create dashboard Observability POST /dashboards REST OAuth2/JWT Target
Create alert rule Observability POST /alerts/rules REST OAuth2/JWT Target
Open incident Observability POST /incidents REST OAuth2/JWT Target
Create feedback item Observability POST /feedback-items REST OAuth2/JWT Target
Project quality Observability GET /quality/projects/{id} REST OAuth2/JWT Target
Project cost Observability GET /cost/projects/{id} REST OAuth2/JWT Target

Governance / Security / Compliance

See Governance.

API Platform Method & Path Type Auth Status
Create policy Governance POST /policies REST OAuth2/JWT Target
Evaluate policy Governance POST /policies/evaluate REST OAuth2/JWT Target
Create approval Governance POST /approvals REST OAuth2/JWT Target
Approve Governance POST /approvals/{id}/approve REST OAuth2/JWT Target
Reject Governance POST /approvals/{id}/reject REST OAuth2/JWT Target
Query audit Governance GET /audit REST OAuth2/JWT Target
Raise security finding Governance POST /security-findings REST OAuth2/JWT Target
Generate compliance report Governance POST /compliance/reports REST OAuth2/JWT Target

Marketplace

See Marketplace.

API Platform Method & Path Type Auth Status
List assets Marketplace GET /marketplace/assets REST OAuth2/JWT Target
Get asset Marketplace GET /marketplace/assets/{id} REST OAuth2/JWT Target
Publish asset Marketplace POST /marketplace/assets REST OAuth2/JWT Target
Release asset version Marketplace POST /marketplace/assets/{id}/versions REST OAuth2/JWT Target
Install asset Marketplace POST /marketplace/assets/{id}/install REST OAuth2/JWT Target
Evaluate asset compatibility Marketplace POST /marketplace/assets/{id}/compatibility/evaluate REST OAuth2/JWT Target

Control Plane

See Control Plane.

API Platform Method & Path Type Auth Status
Create tenant Control Plane POST /tenants REST OAuth2/JWT Target
Create project Control Plane POST /projects REST OAuth2/JWT Target
Create blueprint Control Plane POST /blueprints REST OAuth2/JWT Target
Create workflow Control Plane POST /workflows REST OAuth2/JWT Target
Create agent task Control Plane POST /agent-tasks REST OAuth2/JWT Target
Create approval Control Plane POST /approvals REST OAuth2/JWT Target
Query audit Control Plane GET /audit REST OAuth2/JWT Target
Query usage Control Plane GET /usage REST OAuth2/JWT Target

Runtime Cloud

See Runtime Cloud.

API Platform Method & Path Type Auth Status
Create environment Runtime Cloud POST /runtime/environments REST OAuth2/JWT Target
Create deployment Runtime Cloud POST /runtime/deployments REST OAuth2/JWT Target
Create configuration Runtime Cloud POST /runtime/configurations REST OAuth2/JWT Target
Bind secret Runtime Cloud POST /runtime/secret-bindings REST OAuth2/JWT Target
Set scaling policy Runtime Cloud POST /runtime/scaling-policies REST OAuth2/JWT Target
Get environment Runtime Cloud GET /runtime/environments/{id} REST OAuth2/JWT Target
Get deployment Runtime Cloud GET /runtime/deployments/{id} REST OAuth2/JWT Target
Service health Runtime Cloud GET /runtime/services/{id}/health REST OAuth2/JWT Target
Drift status Runtime Cloud GET /runtime/drift/{id} REST OAuth2/JWT Target

Integration Platform

See Integration Platform.

API Platform Method & Path Type Auth Status
Create connection Integration POST /integrations/connections REST OAuth2/JWT Target
Register provider Integration POST /integrations/providers REST OAuth2/JWT Target
Subscribe webhook Integration POST /webhooks/subscriptions REST OAuth2/JWT Target
Record delivery Integration POST /webhooks/deliveries REST OAuth2/JWT Target
Rotate credential Integration POST /integrations/credentials/rotate REST OAuth2/JWT Target
Get connection Integration GET /integrations/connections/{id} REST OAuth2/JWT Target
Get integration run Integration GET /integrations/runs/{id} REST OAuth2/JWT Target