Ask the Agent — Developer Docs
Synchronous agent questions with citations, plus turn history retrieval.
How do I ask the project agent a question?
POST /v1/projects/{project_id}/messages runs the same ChatAgent the app uses and returns the answer synchronously — the response includes the cited answer, tool usage summary, and any generated artifacts.
Limits and behavior:
- Rate limit: 2/min per key, with a concurrency limit of 2 in-flight questions.
- Send an
Idempotency-Keyheader — a retried request returns the original turn instead of re-running (and re-billing) the agent. - Before the project is ready you get
409withbootstrap_not_ready; when parcels still need zoning confirmation you get409withzoning_verification_required. PollGET /v1/projects/{project_id}and retry.
Reading turns back:
| Endpoint | What it returns |
|---|---|
GET /v1/projects/{project_id}/messages/{turn_id} | One prior turn (question, answer, citations, artifacts) |
GET /v1/projects/{project_id}/messages | Turn list for the project — API-surface turns only, not in-app chat history |