# Svantic

> AI agent platform — discovery, orchestration, governance, and knowledge for agent fleets.

## Docs

- [Agent card discovery](https://docs.svantic.com/api-reference/agents/agent-card-discovery.md): Returns the public A2A-protocol-compliant agent card. This endpoint requires no authentication and is used by other agents and clients to discover capabilities, supported transports, and skills before initiating communication.
- [Agent heartbeat](https://docs.svantic.com/api-reference/agents/agent-heartbeat.md): Updates the last-seen timestamp for an agent instance and optionally reports its current status.
- [Aggregate agent connection counters](https://docs.svantic.com/api-reference/agents/aggregate-agent-connection-counters.md): Returns tenant-scoped aggregates of connection state for the Agents dashboard summary cards. The response groups the `agent_instances` rows by `deployment_mode`, `connection_status`, and `transport`.
- [Allow Agent Type](https://docs.svantic.com/api-reference/agents/allow-agent-type.md): Add an agent type to the tenant's allow-list. Once allowed, agents of this type can register via `POST /agents/register` even when the tenant's `policy_mode` is `allow-list`. Idempotent — returns `was_new: false` if the type is already in the list.
- [Deregister Agent](https://docs.svantic.com/api-reference/agents/deregister-agent.md): Remove a previously registered agent instance gracefully. It will not accept any new sessions and close all the existing sessions.
- [Disallow Agent Type](https://docs.svantic.com/api-reference/agents/disallow-agent-type.md): Remove an agent type from the tenant's allow-list and cascade-deregister all running instances of that type for the tenant. After this call, new registrations of this type will be rejected when `policy_mode` is `allow-list`. Existing instances are immediately deregistered and their sessions unbound.
- [Get agent connection state](https://docs.svantic.com/api-reference/agents/get-agent-connection-state.md): Returns unified live connection state for a single agent instance. The response shape is identical for hosted (HTTP callback) and connected (WebSocket) deployments; switch on the `transport` and `connection_status` fields to render.
- [Get agent instance detail](https://docs.svantic.com/api-reference/agents/get-agent-instance-detail.md): Returns full detail for a single agent instance identified by instance_id.
- [List agent instances](https://docs.svantic.com/api-reference/agents/list-agent-instances.md): Lists registered agent instances for the caller's tenant, optionally filtered by agent_type. Results are grouped by agent_type. Requires `read` scope.
- [Register Agent](https://docs.svantic.com/api-reference/agents/register-agent.md): Create or update an agent instance. Registration is policy-gated based on the your organizations's `policy_mode`: - **open** (default) — Any agent type is auto-admitted. The type is added to the   tenant's allow-list automatically.
- [Get Token](https://docs.svantic.com/api-reference/credentials-&-access/get-token.md): Exchanges a credential pair (client_id + client_secret) for a signed JWT. The client_id is a credential_id obtained from `/internal/credentials/create`. Optional expires_in controls the JWT lifetime in seconds (default: 86400 = 24 hours).
- [Create a knowledge base](https://docs.svantic.com/api-reference/knowledge-base/create-a-knowledge-base.md): Creates a new knowledge base. Returns a job_id for tracking. Requires 'full' scope.
- [Delete a knowledge base](https://docs.svantic.com/api-reference/knowledge-base/delete-a-knowledge-base.md): Deletes a knowledge base and all its data. Requires 'full' scope.
- [Delete a source](https://docs.svantic.com/api-reference/knowledge-base/delete-a-source.md): Deletes a specific source and all its chunks from the knowledge base. Requires 'full' scope.
- [Get a single knowledge base](https://docs.svantic.com/api-reference/knowledge-base/get-a-single-knowledge-base.md): Returns detail for one knowledge base, identified by namespace.
- [Ingest a document](https://docs.svantic.com/api-reference/knowledge-base/ingest-a-document.md): Ingests text content into a knowledge base namespace. For small text payloads the operation completes synchronously and the response includes chunks_created. For large content or file uploads (future) the response returns status "processing" and the caller polls /knowledge_base/get_status. Always re…
- [Knowledge base statistics](https://docs.svantic.com/api-reference/knowledge-base/knowledge-base-statistics.md): Returns chunk and source counts for a namespace.
- [List ingested sources](https://docs.svantic.com/api-reference/knowledge-base/list-ingested-sources.md): Lists all ingested sources (documents) in a knowledge base namespace.
- [List knowledge bases](https://docs.svantic.com/api-reference/knowledge-base/list-knowledge-bases.md): Lists all knowledge bases for the tenant. Tenant is derived from the JWT, not from the request body.
- [Processing job status](https://docs.svantic.com/api-reference/knowledge-base/processing-job-status.md): Returns the status of a processing job (ingest, refresh, create). Poll this endpoint after receiving a job_id from /ingest, /refresh, or /new until the status is "completed" or "failed".
- [Regenerate embeddings](https://docs.svantic.com/api-reference/knowledge-base/regenerate-embeddings.md): Triggers re-embedding for all sources in a namespace. This is always async — returns a job_id with status "processing". Poll /knowledge_base/get_status to track completion. Requires 'full' scope.
- [Semantic search](https://docs.svantic.com/api-reference/knowledge-base/semantic-search.md): Performs semantic (vector) search against a knowledge base namespace. Returns ranked results with scores.
- [Update a knowledge base](https://docs.svantic.com/api-reference/knowledge-base/update-a-knowledge-base.md): Updates config or metadata for an existing knowledge base. Requires 'full' scope.
- [Cancel a running message](https://docs.svantic.com/api-reference/messages/cancel-a-running-message.md): Sets the message state to `canceled` when the message is not already terminal (`completed`, `failed`, or `canceled`). Returns 409 when the message is already terminal. Requires JWT with at least `read` scope.
- [Get a single message by ID](https://docs.svantic.com/api-reference/messages/get-a-single-message-by-id.md): Loads one message by `message_id`. Returns 404 when no row exists. Returns 403 when the message belongs to another tenant unless the caller is a super-admin. Requires JWT with at least `read` scope.
- [List messages for a tenant](https://docs.svantic.com/api-reference/messages/list-messages-for-a-tenant.md): Returns paginated messages for the caller's tenant (derived from JWT) with optional filters on `state` and `session_id`. Every message belongs to exactly one session and tracks the full lifecycle (submitted → working → input-required → completed/failed/canceled). Requires JWT with at least `read` sc…
- [List pending messages (Approval Queue)](https://docs.svantic.com/api-reference/messages/list-pending-messages-approval-queue.md): Returns messages in `input-required` state for the caller's tenant (derived from JWT). These are tasks where an agent is blocked and waiting for human input — approvals, form data, or confirmations. This is the data source for the dashboard Approval Queue.
- [Resolve a pending message](https://docs.svantic.com/api-reference/messages/resolve-a-pending-message.md): Submits a human resolution for a message in `input-required` state. The resolution contains field values matching the A2UI spec's field IDs. On success, the message transitions from `input-required` to `working` and the agent resumes execution. Returns `409 Conflict` if the message was already resol…
- [Send a message (A2A JSON-RPC)](https://docs.svantic.com/api-reference/messages/send-a-message-a2a-json-rpc.md): Accepts JSON-RPC 2.0 requests for agent-to-agent communication within a session context. Supported methods: `message/send` (synchronous) and `message/stream` (SSE streaming). This is the primary endpoint for all agent-to-agent interaction on the platform.
- [Create a policy](https://docs.svantic.com/api-reference/policies/create-a-policy.md): Creates a new guard policy for the specified tenant. The policy scope, name, and decision are required. Requires `admin` scope.
- [Create alert rule](https://docs.svantic.com/api-reference/policies/create-alert-rule.md): Creates an alert rule that triggers notifications when specified conditions are met. Each rule is bound to one or more notification channels.
- [Delete a policy](https://docs.svantic.com/api-reference/policies/delete-a-policy.md): Deletes a policy by tenant_id and policy_id. Requires `admin` scope.
- [Delete alert rule](https://docs.svantic.com/api-reference/policies/delete-alert-rule.md): Deletes an alert rule. No further notifications will fire for this rule.
- [Get a single policy](https://docs.svantic.com/api-reference/policies/get-a-single-policy.md): Returns a single policy identified by tenant_id and policy_id. Requires `admin` scope.
- [List alert rules](https://docs.svantic.com/api-reference/policies/list-alert-rules.md): Lists alert rules for a tenant. Alert rules define conditions under which the platform sends notifications — e.g., when a message enters `input-required`, when an agent goes unhealthy, or when a policy violation occurs.
- [List policies](https://docs.svantic.com/api-reference/policies/list-policies.md): Lists guard policies for the specified tenant, optionally filtered by scope (tool, admission, plan, session, dispatch). Requires `admin` scope.
- [Test alert rule notifications](https://docs.svantic.com/api-reference/policies/test-alert-rule-notifications.md): Sends a test notification to all channels configured in the alert rule. Returns per-channel results with diagnostic information.
- [Update a policy](https://docs.svantic.com/api-reference/policies/update-a-policy.md): Updates an existing policy. Scope is immutable after creation. Only provided fields are updated. Requires `admin` scope.
- [Update alert rule](https://docs.svantic.com/api-reference/policies/update-alert-rule.md): Updates an existing alert rule — change conditions, channels, or enabled state.
- [Close a session](https://docs.svantic.com/api-reference/sessions/close-a-session.md): Gateway endpoint (JWT-authenticated). Marks an existing session as completed and releases associated resources.
- [Create a new session](https://docs.svantic.com/api-reference/sessions/create-a-new-session.md): Gateway endpoint (JWT-authenticated). Creates a new session for the specified agent instance. The tenant_id is extracted from the JWT — it is not supplied in the request body. The session_id is generated server-side and returned in the response.
- [Get session detail](https://docs.svantic.com/api-reference/sessions/get-session-detail.md): Returns detail for a single session identified by session_id. Optionally includes related data via the `include` array (e.g. ["history", "agents"]). Requires `read` scope.
- [Interrupt in-flight streams](https://docs.svantic.com/api-reference/sessions/interrupt-in-flight-streams.md): Cancels any in-flight streaming responses for the given sessions.
- [List sessions](https://docs.svantic.com/api-reference/sessions/list-sessions.md): Returns a paginated list of sessions for the caller's tenant (derived from JWT). Supports optional status filter. Requires `read` scope.
- [Event statistics](https://docs.svantic.com/api-reference/telemetry/event-statistics.md): Returns event bus statistics and event counts grouped by category. Requires `read` scope.
- [List events](https://docs.svantic.com/api-reference/telemetry/list-events.md): Returns a paginated list of events for the caller's tenant with optional filters by session, category, type, and source. Requires `read` scope.
- [List or get traces](https://docs.svantic.com/api-reference/telemetry/list-or-get-traces.md): When `trace_id` is provided, returns the full trace with all spans. Otherwise returns a paginated list of trace summaries with optional filters. Requires `read` scope.
- [Stream events (SSE)](https://docs.svantic.com/api-reference/telemetry/stream-events-sse.md): Opens a Server-Sent Events stream of real-time platform events. Sends `: connected` on open, replays recent buffered events, then streams live events as `data: {json}`. A keepalive comment is sent every 30 seconds. Requires `read` scope.
- [Usage statistics](https://docs.svantic.com/api-reference/telemetry/usage-statistics.md): Returns usage data for the caller's tenant. Supports three modes — summary (aggregated totals), grouped aggregation (by agent_type or model), and per-session records. Requires `read` scope.
- [Agents connect](https://docs.svantic.com/api-reference/websocket/agents-connect.md)
- [Connecting agents](https://docs.svantic.com/build/connecting-agents.md)
- [Existing services](https://docs.svantic.com/build/existing-services.md)
- [Forge](https://docs.svantic.com/build/forge.md)
- [Telemetry](https://docs.svantic.com/build/telemetry.md)
- [Your first agent](https://docs.svantic.com/build/your-first-agent.md)
- [Environment and Configuration](https://docs.svantic.com/cli-reference/environment-and-config.md): Complete reference for Svantic CLI environment variables, configuration files, and authentication.
- [Forge Commands](https://docs.svantic.com/cli-reference/forge-commands.md): Guide to using Svantic Forge for generating tools and scaffolding agents from OpenAPI specs, source code, or natural language.
- [Headless Mode](https://docs.svantic.com/cli-reference/headless-mode.md): Guide to using the Svantic CLI in headless mode for scripting and CI/CD pipelines.
- [CLI Reference](https://docs.svantic.com/cli-reference/index.md): Complete command reference for the Svantic CLI, covering interactive chat, headless mode, forge generation, and platform administration.
- [Interactive Mode](https://docs.svantic.com/cli-reference/interactive-mode.md): Guide to using the Svantic CLI in interactive mode for conversational AI agent sessions.
- [A2ui](https://docs.svantic.com/concepts/a2ui.md)
- [Agents](https://docs.svantic.com/concepts/agents.md)
- [Everything is an agent](https://docs.svantic.com/concepts/everything-is-an-agent.md)
- [Guardrails](https://docs.svantic.com/concepts/guardrails.md)
- [Knowledge base api](https://docs.svantic.com/concepts/knowledge-base-api.md)
- [Knowledge store](https://docs.svantic.com/concepts/knowledge-store.md)
- [Notifications](https://docs.svantic.com/concepts/notifications.md)
- [Push notifications](https://docs.svantic.com/concepts/push-notifications.md)
- [Sessions](https://docs.svantic.com/concepts/sessions.md)
- [Streaming](https://docs.svantic.com/concepts/streaming.md)
- [Tasks](https://docs.svantic.com/concepts/tasks.md)
- [Tools and capabilities](https://docs.svantic.com/concepts/tools-and-capabilities.md)
- [1 Minute Concepts](https://docs.svantic.com/core-concepts.md): The building blocks of Svantic — agents, capabilities, sessions, knowledge, telemetry, policies, and the interfaces you use.
- [Configuration](https://docs.svantic.com/deployment/configuration.md)
- [Deployment](https://docs.svantic.com/deployment/index.md)
- [Topologies](https://docs.svantic.com/deployment/topologies.md)
- [Composing agents](https://docs.svantic.com/forge/composing-agents.md)
- [From natural language](https://docs.svantic.com/forge/from-natural-language.md)
- [From openapi](https://docs.svantic.com/forge/from-openapi.md)
- [From source code](https://docs.svantic.com/forge/from-source-code.md)
- [Forge](https://docs.svantic.com/forge/index.md)
- [Iterative generation](https://docs.svantic.com/forge/iterative-generation.md)
- [Tool spec format](https://docs.svantic.com/forge/tool-spec-format.md)
- [Getting Started](https://docs.svantic.com/getting-started.md): Clone an agent, connect to the mesh, talk to it — in under 10 minutes.
- [Approvals](https://docs.svantic.com/guides/approvals.md)
- [Notification Channels & Templates](https://docs.svantic.com/guides/channels.md)
- [File handling](https://docs.svantic.com/guides/file-handling.md)
- [Policy Architecture](https://docs.svantic.com/guides/policies.md)
- [Webhooks](https://docs.svantic.com/guides/webhooks.md)
- [Mental Model](https://docs.svantic.com/mental-model.md): How Svantic works — in 30 seconds.
- [Datadog plugin](https://docs.svantic.com/plugins/datadog-plugin.md)
- [Zendesk plugin](https://docs.svantic.com/plugins/zendesk-plugin.md)
- [Attach to express](https://docs.svantic.com/sdk/guides/attach-to-express.md)
- [Calling other agents](https://docs.svantic.com/sdk/guides/calling-other-agents.md)
- [Connecting](https://docs.svantic.com/sdk/guides/connecting.md)
- [Defining capabilities](https://docs.svantic.com/sdk/guides/defining-capabilities.md)
- [Guides](https://docs.svantic.com/sdk/guides/index.md)
- [Mcp integration](https://docs.svantic.com/sdk/guides/mcp-integration.md)
- [Quickstart](https://docs.svantic.com/sdk/guides/quickstart.md)
- [Securing dispatches](https://docs.svantic.com/sdk/guides/securing-dispatches.md)
- [Sensitive forms](https://docs.svantic.com/sdk/guides/sensitive-forms.md)
- [Smart agents](https://docs.svantic.com/sdk/guides/smart-agents.md)
- [Telemetry](https://docs.svantic.com/sdk/guides/telemetry.md)
- [Triggers](https://docs.svantic.com/sdk/guides/triggers.md)
- [Sdk](https://docs.svantic.com/sdk/index.md)
- [A2ui](https://docs.svantic.com/sdk/reference/a2ui.md)
- [Agent](https://docs.svantic.com/sdk/reference/agent.md)
- [Agent discovery](https://docs.svantic.com/sdk/reference/agent-discovery.md)
- [Attach](https://docs.svantic.com/sdk/reference/attach.md)
- [Builtin tools](https://docs.svantic.com/sdk/reference/builtin-tools.md)
- [Dispatch auth](https://docs.svantic.com/sdk/reference/dispatch-auth.md)
- [Reference](https://docs.svantic.com/sdk/reference/index.md)
- [Mcp bridge](https://docs.svantic.com/sdk/reference/mcp-bridge.md)
- [Mesh connector](https://docs.svantic.com/sdk/reference/mesh-connector.md)
- [Message builder](https://docs.svantic.com/sdk/reference/message-builder.md)
- [Remote agent](https://docs.svantic.com/sdk/reference/remote-agent.md)
- [Telemetry](https://docs.svantic.com/sdk/reference/telemetry.md)
- [Trace propagation](https://docs.svantic.com/sdk/reference/trace-propagation.md)
- [Types](https://docs.svantic.com/sdk/reference/types.md)
- [Authentication](https://docs.svantic.com/security/authentication.md)
- [Credentials](https://docs.svantic.com/security/credentials.md)
- [Encryption](https://docs.svantic.com/security/encryption.md)
- [Security](https://docs.svantic.com/security/index.md)
- [What is Svantic](https://docs.svantic.com/what-is-svantic.md): Not a chatbot framework — a control plane for autonomous work. Build agents from existing services, orchestrate them, govern every decision.
- [When to Use Svantic](https://docs.svantic.com/when-to-use-svantic.md): Is Svantic right for your use case? A quick checklist.

## OpenAPI Specs

- [openapi-bundled](https://docs.svantic.com/api-reference/openapi-bundled.yaml)
- [bff-paths](https://docs.svantic.com/api-reference/bff-paths.yaml)