/api/agent

POST /api/agent/v1/read-resource

Changed on

Read one or more Metabase resources via metabase:// URI patterns.

Calls the read_resource tool in metabase.metabot.tools.resources — the same record the agent loop calls, so URI dispatch, per-URI permission checks and the per-URI failure text are shared. A URI that cannot be read becomes that item's :error; the call still returns 200 with the items that did read. Each request accepts up to five URIs; oversized batches return 400 before any reads.

post/api/agent/v1/read-resource

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

urisstring[] required

A non-empty array of at most 5 URIs, each at most 4096 characters. Request fewer URIs or shorten them to fit these limits.

Response

Successful response

outputstring required

Changes