Agent API Reference

Per-endpoint parameter reference for the Agent API, generated from the live OpenAPI spec.

This is the index of the Agent API's endpoints. Pick an operation below to see every parameter and response field, generated directly from the live OpenAPI spec at /api/v1/agent/openapi.json.

For setup, auth, error shapes, and rate limits, see the Agent API guide.

Make your first call

Create an API key in Settings → API Keys, then search your knowledge base. Replace the base URL with your own domain if you self-host.

curl -H "Authorization: Bearer <your-api-key>" \
  "https://answerloops.com/api/v1/agent/kb/search?query=how+do+I+reset+my+api+key&limit=5"

Each result has a question, an answer and a score.

How a request flows

Your code sends a request with an API key, answerLoops runs the operation for that key's workspace, and a JSON response comes back.

Endpoints

Search the knowledge base

Semantically search the organization's knowledge base

Get the latest FAQ

Read the auto-generated FAQ for the organization

List tickets

List support tickets, optionally filtered by status

Create a ticket

File a new support ticket

Generate an answer

Run the confidence-gated answer pipeline against a question

Agent API Reference

Make your first callCopy Anchor Link

How a request flowsCopy Anchor Link

EndpointsCopy Anchor Link