Askhive engine API

Turn a question into a structured report. Invite-only beta.

Last updated: 8 September 2026

Invite-only

The Askhive engine API is in a closed beta. Keys are issued by us to named partners; if you have not been given one, write to support@bridgeshorelabs.com and tell us what you want to build.

What it does

You send a question. You get back a structured report — not prose — as JSON in the same twelve-block schema the Askhive apps render, plus a branded HTML rendering if you want one. The engine decides how long the report should be from the question itself.

Authentication

Every request carries your key as a bearer token. Sandbox keys start ak_test_; they are rate limited, capped daily, and never billed.

Authorization: Bearer ak_test_...

We store only a hash of your key. If you lose it, we cannot recover it — revoke it and make another.

Create a report

curl -X POST https://askhive.app/v1/reports   -H "Authorization: Bearer $ASKHIVE_KEY"   -H "Content-Type: application/json"   -d '{"question":"How should a family of four think about an emergency fund?"}'

Returns 201 with { id, tier, report, usage }. tier is the length the engine chose — quick, standard or deep. Pass "effort":"deep" to insist.

Revise it

curl -X POST https://askhive.app/v1/reports/{id}/revise   -H "Authorization: Bearer $ASKHIVE_KEY"   -H "Content-Type: application/json"   -d '{"instruction":"Add a line about high-yield savings."}'

Returns the full updated report and a new version. Revisions are not billed.

Fetch it

curl https://askhive.app/v1/reports/{id}   -H "Authorization: Bearer $ASKHIVE_KEY"

Render it

curl -X POST https://askhive.app/v1/reports/{id}/render   -H "Authorization: Bearer $ASKHIVE_KEY"   -H "Content-Type: application/json"   -d '{"format":"html","client_name":"Sam Okafor"}'

Returns a complete HTML document carrying your firm's branding from your Practice workspace, and "Prepared for …" when you pass a name. On the White Label tier every Askhive mark is removed. "format":"pdf" returns 501 today with the HTML in the body — print it yourself, or ask us to prioritise server-side PDF.

Limits

• Rate: 30 requests a minute per key.
• Sandbox: 25 reports a day, never billed.
• Live: the first 100 reports a month per key are free, then $0.25 per report for the first 5,000 in a month and $0.15 above that. Revisions and renders are included — you are billed for reports you create, not for changing or rendering them. Every response carries a usage object so you always know where you stand.
• Beta terms: invite-only, no SLA, and 30 days' notice before any price change.
• Moderation and length caps apply exactly as they do in the apps. A request we will not answer returns 422.

Errors

Every error is { "error": "...", "hint": "..." }. The hint is written for a person reading a log. 401 invalid or revoked key · 404 no such report for your key · 422 refused content · 429 rate or daily limit · 502 the engine did not return a usable report.

Stability

The path is versioned at /v1. The twelve-block schema is held stable by a regression suite that runs against these same endpoints, so a block will not change shape under you without the version changing.

Terms

Use of the API is subject to our Terms and the API addendum we send with your key. You are responsible for what you do with the output; it is drafting software, and reports can be wrong.