The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
docs - agent API oss (#71380)
Jeff Bruemmer1dbfa6588526
diff --git a/docs/ai/agent-api.md b/docs/ai/agent-api.mdindex d1f34e6a306..796648a2b55 100644--- a/docs/ai/agent-api.md+++ b/docs/ai/agent-api.md@@ -6,10 +6,14 @@ summary: The Agent API is a REST API for building headless, agentic BI applicati# Agent API-{% include plans-blockquote.html feature="Metabase agent API" %}-The Agent API is a REST API for building headless, agentic BI applications on top of Metabase's semantic layer, scoped to an authenticated user's permissions.+## Example application++++Check out the [Metabase Agent API demo](https://github.com/metabase/metabase-agent-api-demo) for a working example of an agentic BI app built on the Agent API.+## Why use the Agent APIThere are a few advantages to using the agent API over the Metabase API.@@ -27,7 +31,11 @@ The Agent API supports:- Inspecting their fields- Constructing and executing queries-Base path:[/api/agent](../api.html#tag/apiagent)+## Agent API endpoints and reference++Check out the API endpoints: [/api/agent](../api.html#tag/apiagent).++You can also point your AI to the [Agent API reference](https://github.com/metabase/metabase/blob/master/src/metabase/agent_api/reference.md) to bootstrap your agent.## Authentication@@ -58,14 +66,17 @@ Example JWT payload:}```-## Example application+### Session-based authentication-+Exchange a JWT at `POST /auth/sso/to_session` to get a session token, then pass it via:-Check out the [Metabase Agent API demo](https://github.com/metabase/metabase-agent-api-demo) for a working example of an agentic BI app built on the Agent API.+```+X-Metabase-Session: <session-token>+```## Further reading+- [Agent API complete reference](https://github.com/metabase/metabase/blob/master/src/metabase/agent_api/reference.md)- [Metabase Agent API demo](https://github.com/metabase/metabase-agent-api-demo)- [Metabase API docs](../api.html)- [JWT authentication](../people-and-groups/authenticating-with-jwt.md)