{ "generated": "2026-06-23T18:38:49.316Z", "product": "Caracal", "baseUrl": "https://docs.caracal.run", "pages": [ { "id": "404", "url": "https://docs.caracal.run/404/", "markdownUrl": "https://docs.caracal.run/markdown/404.md", "title": "Page not found", "description": "We could not find that Caracal documentation page.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api", "url": "https://docs.caracal.run/api/", "markdownUrl": "https://docs.caracal.run/markdown/api.md", "title": "Use API Reference", "description": "Current HTTP APIs, Gateway proxy behavior, STS exchange, Coordinator endpoints, and stream topics.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api/control-plane", "url": "https://docs.caracal.run/api/control-plane/", "markdownUrl": "https://docs.caracal.run/markdown/api/control-plane.md", "title": "Use Management API", "description": "Management API endpoints served by the Caracal API service.", "pageType": "api", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api/coordinator", "url": "https://docs.caracal.run/api/coordinator/", "markdownUrl": "https://docs.caracal.run/markdown/api/coordinator.md", "title": "Use Coordinator API", "description": "Agent-session, service-agent, invocation, and delegation endpoints served by Coordinator.", "pageType": "api", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api/event-topics", "url": "https://docs.caracal.run/api/event-topics/", "markdownUrl": "https://docs.caracal.run/markdown/api/event-topics.md", "title": "Use Event Topics", "description": "Redis Stream topic names, producers, consumers, and contracts.", "pageType": "api", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api/gateway", "url": "https://docs.caracal.run/api/gateway/", "markdownUrl": "https://docs.caracal.run/markdown/api/gateway.md", "title": "Proxy Through Gateway", "description": "Protected reverse-proxy behavior, routing headers, denial checks, and upstream forwarding.", "pageType": "api", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "api/sts", "url": "https://docs.caracal.run/api/sts/", "markdownUrl": "https://docs.caracal.run/markdown/api/sts.md", "title": "Use STS Endpoint", "description": "OAuth token exchange, JWKS, step-up, and internal policy endpoints served by STS.", "pageType": "api", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture", "url": "https://docs.caracal.run/architecture/", "markdownUrl": "https://docs.caracal.run/markdown/architecture.md", "title": "Understand Architecture", "description": "Current Caracal system architecture, request flows, state propagation, storage, keys, and trust boundaries.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/crypto-keys", "url": "https://docs.caracal.run/architecture/crypto-keys/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/crypto-keys.md", "title": "Manage Keys", "description": "Key material, signatures, HMACs, JWKS, and rotation boundaries in Caracal.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/delegation-flow", "url": "https://docs.caracal.run/architecture/delegation-flow/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/delegation-flow.md", "title": "Coordinate Agents", "description": "How agent sessions, delegation edges, and invocation lifecycle move through Coordinator.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/event-streams", "url": "https://docs.caracal.run/architecture/event-streams/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/event-streams.md", "title": "Propagate Events", "description": "Redis Streams, transactional outboxes, consumer groups, and replay paths in Caracal.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/storage-model", "url": "https://docs.caracal.run/architecture/storage-model/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/storage-model.md", "title": "Store State", "description": "Durable Postgres tables, Redis streams, replay files, and ownership boundaries.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/system-topology", "url": "https://docs.caracal.run/architecture/system-topology/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/system-topology.md", "title": "Map the System", "description": "Runtime topology for Caracal services, dependencies, and external clients.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/token-exchange-flow", "url": "https://docs.caracal.run/architecture/token-exchange-flow/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/token-exchange-flow.md", "title": "Exchange Tokens", "description": "How STS exchanges authority for scoped Caracal mandates.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "architecture/trust-boundaries", "url": "https://docs.caracal.run/architecture/trust-boundaries/", "markdownUrl": "https://docs.caracal.run/markdown/architecture/trust-boundaries.md", "title": "Enforce Boundaries", "description": "Security boundaries between users, runtime CLI, Console, Control API, services, storage, and upstreams.", "pageType": "architecture", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "blog/caracal-joins-lfx-mentorship", "url": "https://docs.caracal.run/blog/caracal-joins-lfx-mentorship/", "markdownUrl": "https://docs.caracal.run/markdown/blog/caracal-joins-lfx-mentorship.md", "title": "Caracal Joins LFX Mentorship", "description": "Why Caracal is taking part in the Linux Foundation's LFX Mentorship program, and what mentees and the project get out of it.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "blogs", "url": "https://docs.caracal.run/blogs/", "markdownUrl": "https://docs.caracal.run/markdown/blogs.md", "title": "Blogs", "description": "Articles from the Caracal team and community on agent authority, policy design, delegation, identity, and audit.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts", "url": "https://docs.caracal.run/concepts/", "markdownUrl": "https://docs.caracal.run/markdown/concepts.md", "title": "Understand the Model", "description": "Learn the mental model behind scoped authority, policy decisions, delegation, revocation, and audit in Caracal.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/audit-ledger", "url": "https://docs.caracal.run/concepts/audit-ledger/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/audit-ledger.md", "title": "Audit and Request Traces", "description": "Decision events and diagnostics that explain Caracal authority.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/authority-model", "url": "https://docs.caracal.run/concepts/authority-model/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/authority-model.md", "title": "Authority and Enforcement", "description": "How Caracal enforces authority before a request reaches its target.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/constraint", "url": "https://docs.caracal.run/concepts/constraint/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/constraint.md", "title": "Delegation Constraints", "description": "Resource, TTL, hop, budget, and approval restrictions that travel with a delegation edge.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/delegation", "url": "https://docs.caracal.run/concepts/delegation/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/delegation.md", "title": "Agent Delegation", "description": "Directed, cycle-checked edges that pass scoped authority between agent sessions.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/mandate", "url": "https://docs.caracal.run/concepts/mandate/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/mandate.md", "title": "Mandates", "description": "The short-lived, signed JWT that carries approved session or resource authority.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/model-overview", "url": "https://docs.caracal.run/concepts/model-overview/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/model-overview.md", "title": "Caracal Mental Model", "description": "Six nouns, three verbs, and one decision point that explain Caracal.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/policy", "url": "https://docs.caracal.run/concepts/policy/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/policy.md", "title": "Policies and Policy Sets", "description": "Versioned policy data documents the platform decision contract evaluates inside the STS at token-exchange time.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/principal", "url": "https://docs.caracal.run/concepts/principal/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/principal.md", "title": "Identities and Applications", "description": "Applications, users, services, and agents that act inside a zone.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/resource-grant", "url": "https://docs.caracal.run/concepts/resource-grant/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/resource-grant.md", "title": "Resources and Grants", "description": "Resources expose protected targets and scopes; grants bind principals to subsets of those scopes.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/sessions-revocation", "url": "https://docs.caracal.run/concepts/sessions-revocation/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/sessions-revocation.md", "title": "Sessions and Revocation", "description": "Agent sessions, cascading revocation, and the revocation event stream.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/step-up", "url": "https://docs.caracal.run/concepts/step-up/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/step-up.md", "title": "Step-Up Challenges", "description": "How policies require fresh proof of authority for sensitive resources.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "concepts/zone", "url": "https://docs.caracal.run/concepts/zone/", "markdownUrl": "https://docs.caracal.run/markdown/concepts/zone.md", "title": "Zones", "description": "The tenancy boundary that owns policies, keys, resources, sessions, and audit.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing", "url": "https://docs.caracal.run/contributing/", "markdownUrl": "https://docs.caracal.run/markdown/contributing.md", "title": "Contribute to Caracal", "description": "Contributor guide for local setup, project standards, workflow, validation, governance, and releases.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/governance", "url": "https://docs.caracal.run/contributing/governance/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/governance.md", "title": "Understand Governance", "description": "Maintainer ownership, contribution process, security process, and community expectations.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/release", "url": "https://docs.caracal.run/contributing/release/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/release.md", "title": "Release Caracal", "description": "CalVer releases, package publishing, protected workflows, and rollback rules.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/setup", "url": "https://docs.caracal.run/contributing/setup/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/setup.md", "title": "Set Up Locally", "description": "Install dependencies and start a local Caracal development stack.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/style", "url": "https://docs.caracal.run/contributing/style/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/style.md", "title": "Follow Project Standards", "description": "Repository conventions for code, docs, naming, command ownership, and product boundaries.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/testing", "url": "https://docs.caracal.run/contributing/testing/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/testing.md", "title": "Validate Changes", "description": "Test commands and validation strategy for Caracal contributors.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "contributing/workflow", "url": "https://docs.caracal.run/contributing/workflow/", "markdownUrl": "https://docs.caracal.run/markdown/contributing/workflow.md", "title": "Make a Change", "description": "How to plan, implement, validate, and submit Caracal changes.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "enterprise", "url": "https://docs.caracal.run/enterprise/", "markdownUrl": "https://docs.caracal.run/markdown/enterprise.md", "title": "Compare Editions", "description": "Compare the open-source Community Edition with the commercial Caracal Enterprise Edition.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "enterprise/compliance-readiness", "url": "https://docs.caracal.run/enterprise/compliance-readiness/", "markdownUrl": "https://docs.caracal.run/markdown/enterprise/compliance-readiness.md", "title": "Compliance and Operations Readiness", "description": "A conservative, evidence-mapped review of Caracal Community Edition against OWASP Agentic AI, NIST AI RMF, the EU AI Act, SOC 2, and agentic authority controls, written for enterprise adoption.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples", "url": "https://docs.caracal.run/examples/", "markdownUrl": "https://docs.caracal.run/markdown/examples.md", "title": "Use Examples", "description": "Choose the right runnable example for learning, automation, validation, or full reference-lab integration.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/control-bootstrap", "url": "https://docs.caracal.run/examples/control-bootstrap/", "markdownUrl": "https://docs.caracal.run/markdown/examples/control-bootstrap.md", "title": "Bootstrap Control State", "description": "Keep an agent environment in sync with a declared plan through a scoped Control API automation key.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/echo-upstream", "url": "https://docs.caracal.run/examples/echo-upstream/", "markdownUrl": "https://docs.caracal.run/markdown/examples/echo-upstream.md", "title": "Run Echo Upstream", "description": "Start the local protected target that proves Gateway-brokered requests reach an upstream service.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/lynx-capital", "url": "https://docs.caracal.run/examples/lynx-capital/", "markdownUrl": "https://docs.caracal.run/markdown/examples/lynx-capital.md", "title": "Run Lynx Capital", "description": "Run the agent-swarm reference protected by one Caracal managed application per permission boundary and per-agent labeled sessions.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/policy-iterate", "url": "https://docs.caracal.run/examples/policy-iterate/", "markdownUrl": "https://docs.caracal.run/markdown/examples/policy-iterate.md", "title": "Iterate Policy Safely", "description": "Diagnose a denied request, simulate a candidate policy-set version, regression-check expected decisions, and activate only when every gate passes.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/provider-preflight", "url": "https://docs.caracal.run/examples/provider-preflight/", "markdownUrl": "https://docs.caracal.run/markdown/examples/provider-preflight.md", "title": "Check Provider Readiness", "description": "Validate service readiness, dependencies, provider configuration, reachability, and policy authorization before the first Gateway request.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "examples/research-agent", "url": "https://docs.caracal.run/examples/research-agent/", "markdownUrl": "https://docs.caracal.run/markdown/examples/research-agent.md", "title": "Launch Research Agent", "description": "Run a plain CLI agent with Google and OpenAI provider credentials injected by caracal run.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "get-started", "url": "https://docs.caracal.run/get-started/", "markdownUrl": "https://docs.caracal.run/markdown/get-started.md", "title": "Overview", "description": "Decide whether Caracal fits, then follow the shortest path to a protected, audited agent call.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "get-started/add-sdk-to-your-app", "url": "https://docs.caracal.run/get-started/add-sdk-to-your-app/", "markdownUrl": "https://docs.caracal.run/markdown/get-started/add-sdk-to-your-app.md", "title": "Add SDK to Your App", "description": "Use the generated runtime profile from your first protected call in TypeScript, Python, or Go.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "get-started/first-protected-call", "url": "https://docs.caracal.run/get-started/first-protected-call/", "markdownUrl": "https://docs.caracal.run/markdown/get-started/first-protected-call.md", "title": "First Protected Call", "description": "Start Caracal, create one protected resource, call it through the Gateway, and inspect audit.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "get-started/first-run-troubleshooting", "url": "https://docs.caracal.run/get-started/first-run-troubleshooting/", "markdownUrl": "https://docs.caracal.run/markdown/get-started/first-run-troubleshooting.md", "title": "First-Run Troubleshooting", "description": "Fix common install, readiness, profile, STS, Gateway, upstream, and audit issues during onboarding.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "get-started/install-caracal", "url": "https://docs.caracal.run/get-started/install-caracal/", "markdownUrl": "https://docs.caracal.run/markdown/get-started/install-caracal.md", "title": "Install Caracal", "description": "Install the released Caracal CLI and Console, then verify Docker for the local stack.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides", "url": "https://docs.caracal.run/guides/", "markdownUrl": "https://docs.caracal.run/markdown/guides.md", "title": "Guides", "description": "Task-focused implementation guides for modeling, authorizing, integrating, protecting, operating, and extending Caracal.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/activate-policy-set", "url": "https://docs.caracal.run/guides/activate-policy-set/", "markdownUrl": "https://docs.caracal.run/markdown/guides/activate-policy-set.md", "title": "Activate a Policy Set", "description": "Version policies, bundle them into a policy set, simulate the result, and promote the version to active.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/audit-stream", "url": "https://docs.caracal.run/guides/audit-stream/", "markdownUrl": "https://docs.caracal.run/markdown/guides/audit-stream.md", "title": "Tail and Query the Audit Stream", "description": "Filter audit events, inspect diagnostics, and explain a specific request ID.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/author-policy", "url": "https://docs.caracal.run/guides/author-policy/", "markdownUrl": "https://docs.caracal.run/markdown/guides/author-policy.md", "title": "Author Policy Data", "description": "Author the grant, binding, and confinement data the platform decision contract reads, and validate it before activation.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/authorize-access", "url": "https://docs.caracal.run/guides/authorize-access/", "markdownUrl": "https://docs.caracal.run/markdown/guides/authorize-access.md", "title": "Debug Authorization Decisions", "description": "Diagnose denied exchanges, missing scopes, inactive policy sets, stale sessions, resource mismatches, and missing audit evidence.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/delegation", "url": "https://docs.caracal.run/guides/delegation/", "markdownUrl": "https://docs.caracal.run/markdown/guides/delegation.md", "title": "Implement Multi-Agent Delegation", "description": "Spawn child agents, attach typed constraints, inspect graph impact, and revoke safely.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/enterprise-runtime-patterns", "url": "https://docs.caracal.run/guides/enterprise-runtime-patterns/", "markdownUrl": "https://docs.caracal.run/markdown/guides/enterprise-runtime-patterns.md", "title": "Production Integration Patterns", "description": "Integration patterns for APIs, MCP servers, queues, service mesh, SIEM, provider SDKs, and production rollout.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/modeling-recipes", "url": "https://docs.caracal.run/guides/modeling-recipes/", "markdownUrl": "https://docs.caracal.run/markdown/guides/modeling-recipes.md", "title": "Model Your Application in Caracal", "description": "Map zones, applications, resources, providers, and scopes onto real deployments before creating production objects.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-express", "url": "https://docs.caracal.run/guides/protect-express/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-express.md", "title": "Protect an Express App", "description": "Add the caracalAuth middleware to Express routes to verify mandates and enforce scope requirements.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-fastapi", "url": "https://docs.caracal.run/guides/protect-fastapi/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-fastapi.md", "title": "Protect a FastAPI App", "description": "Add the CaracalASGIAuth middleware to FastAPI or any ASGI app to verify mandates and enforce scope requirements.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-fastmcp", "url": "https://docs.caracal.run/guides/protect-fastmcp/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-fastmcp.md", "title": "Protect a FastMCP App", "description": "Attach CaracalAuth to a FastMCP server so tool calls are mandate-verified before handlers run.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-gateway-http", "url": "https://docs.caracal.run/guides/protect-gateway-http/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-gateway-http.md", "title": "Protect a Gateway-Routed HTTP API", "description": "Configure a resource route so Caracal Gateway verifies mandates, brokers provider credentials, forwards the request, and records action-result audit.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-mcp", "url": "https://docs.caracal.run/guides/protect-mcp/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-mcp.md", "title": "Protect an MCP Server", "description": "Gate MCP tool calls with Caracal mandate verification using framework-neutral transport packages.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/protect-nethttp", "url": "https://docs.caracal.run/guides/protect-nethttp/", "markdownUrl": "https://docs.caracal.run/markdown/guides/protect-nethttp.md", "title": "Protect a Go net/http Service", "description": "Wrap Go HTTP handlers with the mcp-nethttp middleware to verify mandates and attach claims to context.Context.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/provider-recipes", "url": "https://docs.caracal.run/guides/provider-recipes/", "markdownUrl": "https://docs.caracal.run/markdown/guides/provider-recipes.md", "title": "Provider Recipes", "description": "Concrete copy-paste provider setups for OpenAI, Google, GitHub, Slack, and internal APIs, with the enforcement boundary each one uses.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/resources-providers", "url": "https://docs.caracal.run/guides/resources-providers/", "markdownUrl": "https://docs.caracal.run/markdown/guides/resources-providers.md", "title": "Define Resources and Providers", "description": "Register protected upstream resources and explicit provider auth modes from the Console.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/runtime-run", "url": "https://docs.caracal.run/guides/runtime-run/", "markdownUrl": "https://docs.caracal.run/markdown/guides/runtime-run.md", "title": "Run an Agent with caracal run", "description": "Use a generated runtime profile to inject scoped Caracal access into a subprocess.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/sdk-go", "url": "https://docs.caracal.run/guides/sdk-go/", "markdownUrl": "https://docs.caracal.run/markdown/guides/sdk-go.md", "title": "Integrate the Go SDK", "description": "Install the Go SDK, load a generated profile, spawn agents with context.Context, delegate authority, and inject Caracal headers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/sdk-python", "url": "https://docs.caracal.run/guides/sdk-python/", "markdownUrl": "https://docs.caracal.run/markdown/guides/sdk-python.md", "title": "Integrate the Python SDK", "description": "Install caracalai-sdk, load a generated profile, spawn agents with async context managers, delegate authority, and use httpx transport injection.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/sdk-typescript", "url": "https://docs.caracal.run/guides/sdk-typescript/", "markdownUrl": "https://docs.caracal.run/markdown/guides/sdk-typescript.md", "title": "Integrate the TypeScript SDK", "description": "Install @caracalai/sdk, load a generated profile, spawn agents, delegate authority, and inject Caracal headers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/serve-customers", "url": "https://docs.caracal.run/guides/serve-customers/", "markdownUrl": "https://docs.caracal.run/markdown/guides/serve-customers.md", "title": "Serve Your Own Customers", "description": "Run one Caracal deployment that serves many of your customers, with per-customer identity, policy, audit, and revocation.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "guides/step-up", "url": "https://docs.caracal.run/guides/step-up/", "markdownUrl": "https://docs.caracal.run/markdown/guides/step-up.md", "title": "Step-Up Re-Authentication", "description": "Handle interaction_required from the STS, satisfy the challenge, and retry token exchange with proof.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations", "url": "https://docs.caracal.run/operations/", "markdownUrl": "https://docs.caracal.run/markdown/operations.md", "title": "Operate Caracal", "description": "Operator runbooks for deploying, configuring, securing, observing, recovering, releasing, and handing off Caracal.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/alerts", "url": "https://docs.caracal.run/operations/alerts/", "markdownUrl": "https://docs.caracal.run/markdown/operations/alerts.md", "title": "Configure Alerts", "description": "Alert names, meanings, and first-response actions for Caracal operations.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/backup-retention", "url": "https://docs.caracal.run/operations/backup-retention/", "markdownUrl": "https://docs.caracal.run/markdown/operations/backup-retention.md", "title": "Back Up and Retain Data", "description": "Back up and retain Caracal database, secrets, audit evidence, and replay state.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/cloud-native-profiles", "url": "https://docs.caracal.run/operations/cloud-native-profiles/", "markdownUrl": "https://docs.caracal.run/markdown/operations/cloud-native-profiles.md", "title": "Choose a Cloud Profile", "description": "Configure Caracal for managed Kubernetes, managed Postgres, Redis, ingress, secrets, and observability.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/cloud-reference-deployments", "url": "https://docs.caracal.run/operations/cloud-reference-deployments/", "markdownUrl": "https://docs.caracal.run/markdown/operations/cloud-reference-deployments.md", "title": "Deploy on Managed Kubernetes", "description": "Concrete managed-Kubernetes reference for Caracal with External Secrets, cert-manager TLS, and managed Postgres and Redis.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/compliance-audit-integration", "url": "https://docs.caracal.run/operations/compliance-audit-integration/", "markdownUrl": "https://docs.caracal.run/markdown/operations/compliance-audit-integration.md", "title": "Export Audit Evidence", "description": "Export, verify, and preserve Caracal audit evidence for compliance workflows.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/debugging", "url": "https://docs.caracal.run/operations/debugging/", "markdownUrl": "https://docs.caracal.run/markdown/operations/debugging.md", "title": "Debug Infrastructure Issues", "description": "Diagnose Caracal deployment, configuration, token exchange, Gateway, audit, and delegation issues.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/docker-compose", "url": "https://docs.caracal.run/operations/docker-compose/", "markdownUrl": "https://docs.caracal.run/markdown/operations/docker-compose.md", "title": "Deploy with Docker Compose", "description": "Run and verify the local or self-hosted Caracal stack with Docker Compose.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/enterprise-install-kit", "url": "https://docs.caracal.run/operations/enterprise-install-kit/", "markdownUrl": "https://docs.caracal.run/markdown/operations/enterprise-install-kit.md", "title": "Package an Install Kit", "description": "Package and hand off production Caracal installation materials without crossing product boundaries.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/env-vars", "url": "https://docs.caracal.run/operations/env-vars/", "markdownUrl": "https://docs.caracal.run/markdown/operations/env-vars.md", "title": "Configure Service Environment", "description": "Operational environment variables for Caracal services and runtime workloads.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/failure-drills", "url": "https://docs.caracal.run/operations/failure-drills/", "markdownUrl": "https://docs.caracal.run/markdown/operations/failure-drills.md", "title": "Run Failure Drills", "description": "Rehearse Caracal failures by injecting faults and confirming the expected alerts, readiness behavior, and recovery.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/failure-modes", "url": "https://docs.caracal.run/operations/failure-modes/", "markdownUrl": "https://docs.caracal.run/markdown/operations/failure-modes.md", "title": "Recover from Failures", "description": "Recover Caracal from storage, stream, policy, Gateway, STS, audit, and Coordinator failures.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/incident-response", "url": "https://docs.caracal.run/operations/incident-response/", "markdownUrl": "https://docs.caracal.run/markdown/operations/incident-response.md", "title": "Respond to Incidents", "description": "Respond to Caracal access-safety, audit-integrity, and platform incidents.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/key-management", "url": "https://docs.caracal.run/operations/key-management/", "markdownUrl": "https://docs.caracal.run/markdown/operations/key-management.md", "title": "Rotate Keys and Secrets", "description": "Manage Caracal secret material, signing keys, HMAC keys, and rotation evidence.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/kubernetes-helm", "url": "https://docs.caracal.run/operations/kubernetes-helm/", "markdownUrl": "https://docs.caracal.run/markdown/operations/kubernetes-helm.md", "title": "Deploy with Helm", "description": "Deploy Caracal on Kubernetes with the repository Helm chart.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/observability", "url": "https://docs.caracal.run/operations/observability/", "markdownUrl": "https://docs.caracal.run/markdown/operations/observability.md", "title": "Monitor Health and Metrics", "description": "Monitor Caracal health, readiness, metrics, audit flow, and runtime diagnostics.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/platform-rollout-kit", "url": "https://docs.caracal.run/operations/platform-rollout-kit/", "markdownUrl": "https://docs.caracal.run/markdown/operations/platform-rollout-kit.md", "title": "Plan a Platform Rollout", "description": "Plan, gate, execute, and roll back Caracal platform rollouts.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/platform-team-handoff", "url": "https://docs.caracal.run/operations/platform-team-handoff/", "markdownUrl": "https://docs.caracal.run/markdown/operations/platform-team-handoff.md", "title": "Hand Off to Platform Teams", "description": "Handoff checklist for teams operating Caracal in production.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/policy-deployment", "url": "https://docs.caracal.run/operations/policy-deployment/", "markdownUrl": "https://docs.caracal.run/markdown/operations/policy-deployment.md", "title": "Deploy Policy Changes", "description": "Safely validate, activate, observe, and roll back Caracal policy changes.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/postgres", "url": "https://docs.caracal.run/operations/postgres/", "markdownUrl": "https://docs.caracal.run/markdown/operations/postgres.md", "title": "Operate PostgreSQL", "description": "Operate the durable Caracal control-plane database.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/redis", "url": "https://docs.caracal.run/operations/redis/", "markdownUrl": "https://docs.caracal.run/markdown/operations/redis.md", "title": "Operate Redis Streams", "description": "Operate Redis Streams for Caracal events, invalidation, revocation, and coordination.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/scale-capacity", "url": "https://docs.caracal.run/operations/scale-capacity/", "markdownUrl": "https://docs.caracal.run/markdown/operations/scale-capacity.md", "title": "Scale Capacity", "description": "Size Caracal services, storage, and queues for production traffic.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/tls-hardening", "url": "https://docs.caracal.run/operations/tls-hardening/", "markdownUrl": "https://docs.caracal.run/markdown/operations/tls-hardening.md", "title": "Harden Production", "description": "Harden network exposure, secrets, service processes, and upstream access for production Caracal.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/troubleshooting", "url": "https://docs.caracal.run/operations/troubleshooting/", "markdownUrl": "https://docs.caracal.run/markdown/operations/troubleshooting.md", "title": "Troubleshoot by Symptom", "description": "Start from the symptom of a failing or denied Caracal call, locate the surface that failed, inspect the right object, and use the matching diagnostic tool.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "operations/upgrade", "url": "https://docs.caracal.run/operations/upgrade/", "markdownUrl": "https://docs.caracal.run/markdown/operations/upgrade.md", "title": "Upgrade Caracal", "description": "Upgrade Caracal safely across images, Helm chart values, migrations, and runtime configuration.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference", "url": "https://docs.caracal.run/reference/", "markdownUrl": "https://docs.caracal.run/markdown/reference.md", "title": "Use Reference", "description": "Lookup pages for answers, terms, errors, configuration, defaults, compatibility, releases, and wire contracts.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/compatibility", "url": "https://docs.caracal.run/reference/compatibility/", "markdownUrl": "https://docs.caracal.run/markdown/reference/compatibility.md", "title": "Compatibility", "description": "Supported runtimes, package manager, service deployment targets, and docs build assumptions.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/config-precedence", "url": "https://docs.caracal.run/reference/config-precedence/", "markdownUrl": "https://docs.caracal.run/markdown/reference/config-precedence.md", "title": "Configuration Order", "description": "How Caracal chooses runtime profiles, environment values, file secrets, and deployment values.", "pageType": "config", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/configuration", "url": "https://docs.caracal.run/reference/configuration/", "markdownUrl": "https://docs.caracal.run/markdown/reference/configuration.md", "title": "Configuration Keys", "description": "Runtime profile, service environment, and deployment configuration keys.", "pageType": "config", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/defaults-and-limits", "url": "https://docs.caracal.run/reference/defaults-and-limits/", "markdownUrl": "https://docs.caracal.run/markdown/reference/defaults-and-limits.md", "title": "Defaults and Limits", "description": "Current ports, TTLs, timeouts, limits, and operational defaults.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/errors", "url": "https://docs.caracal.run/reference/errors/", "markdownUrl": "https://docs.caracal.run/markdown/reference/errors.md", "title": "Error Codes", "description": "Shared Caracal error codes and response shape.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/faq", "url": "https://docs.caracal.run/reference/faq/", "markdownUrl": "https://docs.caracal.run/markdown/reference/faq.md", "title": "FAQ", "description": "Stable, searchable answers to recurring Caracal modeling, runtime, provider, troubleshooting, and edition questions.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/glossary", "url": "https://docs.caracal.run/reference/glossary/", "markdownUrl": "https://docs.caracal.run/markdown/reference/glossary.md", "title": "Glossary", "description": "Canonical Caracal terms and names used across the documentation.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/interoperability-contracts", "url": "https://docs.caracal.run/reference/interoperability-contracts/", "markdownUrl": "https://docs.caracal.run/markdown/reference/interoperability-contracts.md", "title": "Wire Contracts", "description": "JSON schemas and fixtures for Caracal wire contracts.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/release-package-runtime-map", "url": "https://docs.caracal.run/reference/release-package-runtime-map/", "markdownUrl": "https://docs.caracal.run/markdown/reference/release-package-runtime-map.md", "title": "Release Map", "description": "Release, package, runtime, and service image naming map.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "reference/runtime-exit-codes", "url": "https://docs.caracal.run/reference/runtime-exit-codes/", "markdownUrl": "https://docs.caracal.run/markdown/reference/runtime-exit-codes.md", "title": "CLI Exit Codes", "description": "Exit behavior for top-level caracal runtime CLI commands and Console launch.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "releases", "url": "https://docs.caracal.run/releases/", "markdownUrl": "https://docs.caracal.run/markdown/releases.md", "title": "Releases", "description": "Browse every Caracal release with validation status, published package versions, and downloadable artifacts.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console", "url": "https://docs.caracal.run/runtime-console/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console.md", "title": "Operate Runtime and Console", "description": "Start the local stack, run Console setup, configure workloads, run agents, and inspect operations.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/admin", "url": "https://docs.caracal.run/runtime-console/admin/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/admin.md", "title": "Manage Product Objects", "description": "Manage zones, applications, providers, resources, policies, authority sessions, and Control through the Console.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/agents", "url": "https://docs.caracal.run/runtime-console/agents/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/agents.md", "title": "Manage Agents and Delegation", "description": "Inspect and manage agent sessions and delegation edges through the Console.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/cli-and-console", "url": "https://docs.caracal.run/runtime-console/cli-and-console/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/cli-and-console.md", "title": "Choose the Right Surface", "description": "Decide whether a task belongs in the runtime CLI, Console, Control API, or Admin SDK.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/config-file", "url": "https://docs.caracal.run/runtime-console/config-file/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/config-file.md", "title": "Configure Workloads", "description": "Configure runtime profiles, credential manifests, secret files, and workload service endpoints.", "pageType": "config", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/console", "url": "https://docs.caracal.run/runtime-console/console/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/console.md", "title": "Use the Console", "description": "Launch, navigate, and operate caracal-console.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/observability", "url": "https://docs.caracal.run/runtime-console/observability/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/observability.md", "title": "Inspect Diagnostics and Audit", "description": "Inspect diagnostics, audit events, and request traces through the Console.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/runtime", "url": "https://docs.caracal.run/runtime-console/runtime/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/runtime.md", "title": "Run Workloads", "description": "Use caracal run to inject scoped resource tokens into subprocesses.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "runtime-console/stack", "url": "https://docs.caracal.run/runtime-console/stack/", "markdownUrl": "https://docs.caracal.run/markdown/runtime-console/stack.md", "title": "Start and Check the Stack", "description": "Use caracal up, down, status, and purge to manage the local runtime stack.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks", "url": "https://docs.caracal.run/sdks/", "markdownUrl": "https://docs.caracal.run/markdown/sdks.md", "title": "Choose an SDK or Package", "description": "Choose the Caracal SDK, verification package, transport, connector, admin client, or state backend for your integration.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/admin", "url": "https://docs.caracal.run/sdks/admin/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/admin.md", "title": "Admin Package", "description": "TypeScript client for the Caracal Admin API and Coordinator management surfaces.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors", "url": "https://docs.caracal.run/sdks/connectors/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors.md", "title": "Framework Connectors", "description": "Framework adapters for Caracal-protected resource servers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/asgi", "url": "https://docs.caracal.run/sdks/connectors/asgi/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/asgi.md", "title": "ASGI Connector", "description": "Pure ASGI middleware that verifies Caracal mandates for FastAPI, Starlette, and Quart resource servers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/express", "url": "https://docs.caracal.run/sdks/connectors/express/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/express.md", "title": "Express Connector", "description": "Express 5 middleware for Caracal mandate verification.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/fastmcp", "url": "https://docs.caracal.run/sdks/connectors/fastmcp/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/fastmcp.md", "title": "FastMCP Connector", "description": "FastMCP token verifiers for TypeScript and Python servers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/nethttp", "url": "https://docs.caracal.run/sdks/connectors/nethttp/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/nethttp.md", "title": "Go net/http Connector", "description": "Go middleware for protecting HTTP handlers with Caracal mandate verification.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/postgres", "url": "https://docs.caracal.run/sdks/connectors/postgres/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/postgres.md", "title": "Postgres Token State Backend", "description": "TypeScript Postgres backend for persisted token state.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/connectors/redis", "url": "https://docs.caracal.run/sdks/connectors/redis/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/connectors/redis.md", "title": "Redis Revocation Store", "description": "Shared Redis revocation stores and revocation stream consumers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/go", "url": "https://docs.caracal.run/sdks/go/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/go.md", "title": "Go SDK", "description": "Public API reference for the Go Caracal SDK.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/identity", "url": "https://docs.caracal.run/sdks/identity/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/identity.md", "title": "Identity Package", "description": "JWT verification packages for mandate claims, scopes, targets, agents, delegation, and hop count.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/oauth", "url": "https://docs.caracal.run/sdks/oauth/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/oauth.md", "title": "OAuth Package", "description": "RFC 8693 token exchange clients for Caracal STS.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/python", "url": "https://docs.caracal.run/sdks/python/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/python.md", "title": "Python SDK", "description": "Public API reference for caracalai-sdk.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/revocation", "url": "https://docs.caracal.run/sdks/revocation/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/revocation.md", "title": "Revocation Package", "description": "Revocation-store interfaces and in-memory stores for resource servers.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/transport-a2a", "url": "https://docs.caracal.run/sdks/transport-a2a/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/transport-a2a.md", "title": "A2A Transport", "description": "TypeScript helper for agent-to-agent calls with STS exchange and Caracal context propagation.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/transport-mcp", "url": "https://docs.caracal.run/sdks/transport-mcp/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/transport-mcp.md", "title": "MCP Auth Transport", "description": "Framework-neutral MCP authentication primitives for bearer parsing, mandate verification, and revocation checks.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/typescript", "url": "https://docs.caracal.run/sdks/typescript/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/typescript.md", "title": "TypeScript SDK", "description": "Public API reference for @caracalai/sdk.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "sdks/verification-layer", "url": "https://docs.caracal.run/sdks/verification-layer/", "markdownUrl": "https://docs.caracal.run/markdown/sdks/verification-layer.md", "title": "Verification Layer Overview", "description": "Choose between framework connectors, MCP auth transport, identity verification, revocation stores, and state backends.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security", "url": "https://docs.caracal.run/security/", "markdownUrl": "https://docs.caracal.run/markdown/security.md", "title": "Secure Caracal", "description": "Review Caracal security boundaries, harden production deployments, and report vulnerabilities responsibly.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/disclosure", "url": "https://docs.caracal.run/security/disclosure/", "markdownUrl": "https://docs.caracal.run/markdown/security/disclosure.md", "title": "Report a Vulnerability", "description": "How to report Caracal security vulnerabilities responsibly.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/enterprise-readiness", "url": "https://docs.caracal.run/security/enterprise-readiness/", "markdownUrl": "https://docs.caracal.run/markdown/security/enterprise-readiness.md", "title": "Enterprise Security Readiness", "description": "Evaluate Caracal's security posture, supply-chain controls, release signing, SBOMs, and the checklist an enterprise team reviews before adoption.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/evidence-pack", "url": "https://docs.caracal.run/security/evidence-pack/", "markdownUrl": "https://docs.caracal.run/markdown/security/evidence-pack.md", "title": "Generate an Evidence Pack", "description": "Generate a reproducible evidence pack that demonstrates Caracal's supply-chain, enforcement, and runtime assurance for security and compliance review.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/hardening", "url": "https://docs.caracal.run/security/hardening/", "markdownUrl": "https://docs.caracal.run/markdown/security/hardening.md", "title": "Harden Security Posture", "description": "Security hardening guidance for production Caracal deployments.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/threat-model", "url": "https://docs.caracal.run/security/threat-model/", "markdownUrl": "https://docs.caracal.run/markdown/security/threat-model.md", "title": "Review the Threat Model", "description": "Assets, boundaries, threats, mitigations, and validation checks for Caracal.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "security/verify-releases", "url": "https://docs.caracal.run/security/verify-releases/", "markdownUrl": "https://docs.caracal.run/markdown/security/verify-releases.md", "title": "Verify a Release", "description": "Verify Caracal release signatures, provenance, and checksums before installing or deploying.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services", "url": "https://docs.caracal.run/services/", "markdownUrl": "https://docs.caracal.run/markdown/services.md", "title": "Understand Services", "description": "Service-by-service map for the current Caracal runtime, authority path, management plane, evidence pipeline, and automation surface.", "pageType": "landing", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/api", "url": "https://docs.caracal.run/services/api/", "markdownUrl": "https://docs.caracal.run/markdown/services/api.md", "title": "Manage Product State", "description": "Service reference for the Caracal API service.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/audit", "url": "https://docs.caracal.run/services/audit/", "markdownUrl": "https://docs.caracal.run/markdown/services/audit.md", "title": "Ingest Audit Evidence", "description": "Service reference for audit ingestion, DLQ, tamper checks, retention, search, and metrics.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/control", "url": "https://docs.caracal.run/services/control/", "markdownUrl": "https://docs.caracal.run/markdown/services/control.md", "title": "Automate Management", "description": "Service reference for optional remote management invocation.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/coordinator", "url": "https://docs.caracal.run/services/coordinator/", "markdownUrl": "https://docs.caracal.run/markdown/services/coordinator.md", "title": "Coordinate Agent State", "description": "Service reference for agent sessions, delegation edges, invocations, and lifecycle events.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/gateway", "url": "https://docs.caracal.run/services/gateway/", "markdownUrl": "https://docs.caracal.run/markdown/services/gateway.md", "title": "Protect Upstreams", "description": "Service reference for protected reverse proxying, STS exchange, revocation checks, and upstream safety.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "services/sts", "url": "https://docs.caracal.run/services/sts/", "markdownUrl": "https://docs.caracal.run/markdown/services/sts.md", "title": "Issue Mandates", "description": "Service reference for token exchange, mandate issuance, JWKS, policy evaluation, and step-up status.", "pageType": "reference", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "tutorials", "url": "https://docs.caracal.run/tutorials/", "markdownUrl": "https://docs.caracal.run/markdown/tutorials.md", "title": "Tutorials", "description": "Guided post-onboarding walkthroughs for protecting a real API, connecting app code, tracing one request, and choosing the next integration path.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "tutorials/choose-production-path", "url": "https://docs.caracal.run/tutorials/choose-production-path/", "markdownUrl": "https://docs.caracal.run/markdown/tutorials/choose-production-path.md", "title": "Choose Your Production Integration Path", "description": "Choose the next guide for your production Gateway, SDK, connector, runtime, delegation, audit, or step-up integration.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "tutorials/connect-an-agent", "url": "https://docs.caracal.run/tutorials/connect-an-agent/", "markdownUrl": "https://docs.caracal.run/markdown/tutorials/connect-an-agent.md", "title": "Connect Your App with the SDK", "description": "Wire app code through the SDK so protected calls carry Caracal authority and audit context.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "tutorials/inspect-a-run", "url": "https://docs.caracal.run/tutorials/inspect-a-run/", "markdownUrl": "https://docs.caracal.run/markdown/tutorials/inspect-a-run.md", "title": "Trace One Protected Request", "description": "Follow one protected request through sessions, policy decisions, Gateway action-result audit, and diagnostics.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "tutorials/protect-an-api", "url": "https://docs.caracal.run/tutorials/protect-an-api/", "markdownUrl": "https://docs.caracal.run/markdown/tutorials/protect-an-api.md", "title": "Protect Your First Real API", "description": "Put a Caracal-enforced boundary in front of one real HTTP service or provider route.", "pageType": "workflow", "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null }, { "id": "vlogs", "url": "https://docs.caracal.run/vlogs/", "markdownUrl": "https://docs.caracal.run/markdown/vlogs.md", "title": "Vlogs", "description": "Curated Caracal videos covering community talks, conference presentations, tutorials, and project updates.", "pageType": null, "concepts": [], "relatedConcepts": [], "requires": [], "keywords": [], "aliases": [], "service": null } ] }