Ask a question about a project
Vision API
Ask
Ask a natural language question about a project and get an AI-generated answer with source citations.
POST
Ask a question about a project
Ask answers “what does this project say about X?” by searching across all project content (blocks, features, files), then generating a concise answer grounded in the retrieved context.
Ask is synchronous and returns results immediately (not an async job).
How It Works
- Your question is used to run a hybrid search (semantic + keyword) across the project
- The top results are assembled into a context window
- An LLM generates a 2-4 sentence answer citing the source material
- Up to 5 source references are returned with relevance scores
Example Questions
| Question | What it finds |
|---|---|
| ”What fire rating is required for the stairwell doors?” | Spec blocks, general notes referencing fire ratings |
| ”How many parking spaces are shown?” | Site plan blocks with parking counts |
| ”What concrete mix is specified for the foundation?” | Specification sheets, structural notes |
Sources
Each source in the response includes:| Field | Description |
|---|---|
source_type | Type of content matched (block, feature, or file) |
source_id | ID of the matched entity |
label | Human-readable label (e.g. sheet number, file name) |
score | Relevance score (higher is better) |
Authorizations
API key prefixed with sk_. Example: Authorization: Bearer sk_xxx
Headers
API version
Path Parameters
Project ID
Body
application/json