Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.agent-vault.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

​
Quick start

Wrap your agent process with vault run. It sets AGENT_VAULT_ADDR, AGENT_VAULT_SESSION_TOKEN, and AGENT_VAULT_VAULT, then pre-configures HTTPS_PROXY and the CA trust chain so standard HTTP clients transparently route through the broker: 
agent-vault vault run -- my-agent

​
Target a specific vault

agent-vault vault run --vault myproject -- my-agent

​
Try it out

Your agent calls real API URLs directly. HTTPS_PROXY routes the request through Agent Vault, which matches the host against the vault’s services and injects the stored credential into the auth header for that service. 
curl "https://api.stripe.com/v1/charges?limit=10"
If the service isn’t configured yet, Agent Vault returns a 403 with a proposal_hint. Your agent can use this to create a proposal requesting access.
Your agent never sees or handles credentials. Agent Vault strips whatever the client sends and injects the real API key at the proxy boundary.

​
Other connection flows

  • Agent invites — for cloud-hosted agents or CI pipelines that can’t be wrapped with vault run. See Connect a custom agent.
  • Manual HTTPS_PROXY setup — for containerized agents and sandboxes that need to configure the proxy themselves. See Set HTTPS_PROXY manually.
  • Explicit /proxy endpoint — for clients that can’t honor HTTPS_PROXY (HTTP/2-only runtimes, no CA-mounting). See Explicit proxy endpoint.

​
Discover available services

Call /discover to check which hosts have credentials configured: 
curl ${AGENT_VAULT_ADDR}/discover \
  -H "Authorization: Bearer ${AGENT_VAULT_SESSION_TOKEN}"
Response
{
  "vault": "default",
  "proxy_url": "http://127.0.0.1:14321/proxy",
  "services": [
    { "host": "api.stripe.com", "description": "Stripe API" }
  ],
  "available_credentials": ["STRIPE_KEY"]
}
Requests to hosts not in services go direct, not through the proxy.

​
Next steps

Connect a custom agent

Full guide with manual HTTPS_PROXY setup, error handling, and proposals.

Agent protocol

HTTP reference for sessions, discovery, and proposals.