Generate a zoning-chat response for a location

Answers a question about the zoning rules that apply at one address or plot, the way the Struck zoning chat does. Returns complete JSON by default. Set stream: true for NDJSON events. Charging, retries and deadlines match the technical chat: https://unravel.struck.build/developers#api-charging-and-retries.

post/v1/chat/zoning

Request

Base URL
https://api.struck.build
Auth
HTTP bearer

Headers

Idempotency-Keystring uuid

Optional UUID, scoped to the API key. Reuse with the same normalized body and response mode after an ambiguous failure. Omitted stream and false are equivalent. An admitted duplicate returns 409 without another charge or result replay.

Request body

streamboolean

Return NDJSON only when true. Omitted or false returns complete JSON.

Response

Complete JSON when stream is omitted or false; a UTF-8 NDJSON stream when true. JSON contains the final answer, cited sources and the location facts, with a maximum serialized size of 4,000,000 bytes.

request_idstring uuid required

contentstring required

credits_chargedinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.