Docs AI Agents API Agent — Deep Dive

API Agent — Deep Dive

The API Agent is your full-time API engineer: it sends requests, syncs endpoints with your git repo, fills params and bodies, generates descriptions, and debugs failing calls.

Capabilities

  • Send the active request and stream the response into chat.
  • Analyse the last response — explain the data, status, and suggest fixes.
  • Sync endpoints from a connected git repository (Laravel routes, Express, FastAPI, etc.).
  • Generate example bodies, query params, headers, and Markdown descriptions from source code.
  • Auto-document an entire cluster (Auto Docs button).
  • Persistent multi-chat per cluster — switch chats without losing context.

The Drawer

The API Agent panel slides from the right edge so it never obscures the request/response panes. Drag-resize, dock, or close — the agent keeps running in the background and resurfaces when you re-open it.

Common Prompts

  • “Sync all endpoints from this repo and set params, bodies, descriptions.”
  • “Why does POST /api/orders return 422?”
  • “Add a Bearer auth example and a happy-path test.”
  • “Compare this response to the previous one and tell me what changed.”
Tip: The API Agent automatically uses the active cluster's variables and auth, so you don't have to copy-paste tokens.

Last updated 3 hours ago

No matches.