HushSearchDocs

Agent

Give a goal in plain language; the agent searches, reads and answers with citations.

Answers & researchLong-running: consider /v1/jobs

POST/v1/agent/4 credits

Request
curl -X POST https://api.hushsearch.io/v1/agent/ \
  -H "X-API-Key: hs_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "goal": "Compare the licenses of FastAPI and Django",
  "include_search": true
}'

The agent plans its own searches for the goal, reads the most useful pages and returns a cited answer.

Parameters

FieldTypeDefaultNotes
goalstring—Required. 1–2,000 characters.
max_resultsinteger—Upper bound on sources read.
include_searchbooleanfalseAlso return the raw search hits the agent used.

Response

{
  "goal": "Compare the licences of the top three open-source vector databases",
  "answer": "…",
  "sources": [{ "index": 1, "title": "…", "url": "https://…" }],
  "citation_count": 3,
  "search_results": null,
  "credits_used": 4,
  "credits_remaining": 496,
  "response_time_ms": 8900
}

On this page