> ## Documentation Index > Fetch the complete documentation index at: https://docs.roofkit.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get budget estimate > Returns a saved Budget Estimate in the create response shape. Only the API key that created the estimate can read it. **Required scopes:** `sales_visualizer.use` ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/v1/budget-estimates/{estimate_id} openapi: 3.1.0 info: title: RoofKit Partner API version: 1.0.0 summary: REST JSON API for external RoofKit partner integrations. contact: name: RoofKit Engineering description: > RoofKit Partner API v1 authenticates requests with workspace API keys. API keys bind each request to exactly one workspace; Partner API paths do not accept roofer_id, workspace_id, or tenant identifiers. Authenticated endpoints are limited to 60 requests per minute per API key, method, and route template; invalid authentication attempts are limited separately at 20 requests per minute per client and endpoint. Date-time parameters and fields accept ISO 8601 with Z or a ±HH:MM offset, for example 2026-09-07T04:00:00Z or 2026-09-07T00:00:00-04:00. Both name the same instant and return the same result. Encode + as %2B in a query string. Responses return UTC. A date-time without an offset, for example 2026-09-07T04:00:00, is deprecated. Until the sunset on 2027-01-10T00:00:00Z it is read as UTC, and the response carries a `Deprecation` header (RFC 9745) and a `Sunset` header (RFC 8594). From the sunset, Z or a ±HH:MM offset is required. A date-time without an offset then returns 400 with the `VALIDATION_ERROR` code, and the response carries no `Deprecation` or `Sunset` header. Each API key holds only the scopes that a workspace owner or admin chose when the key was created, and its scopes never change. Each operation lists the scopes it requires in `x-required-scopes`. A new key in Settings starts on the Read-only preset: `leads.read`, `analytics.read`, `reports.read`, and `data_objects.read`. A Read-only key can call every read operation except exports, Sales Visualizer reads, and trashed Data Objects, and it cannot call any write operation. A call that needs a scope the key does not hold returns 403 `FORBIDDEN`, and `error.details.required_scope` names a missing scope. servers: - url: https://api.roofkit.ai description: Canonical RoofKit Partner API origin security: - ApiKeyBearer: [] tags: - name: Foundation description: Authentication and contract foundation endpoints. - name: Leads description: Partner CRM lead sync endpoints. - name: Attribution description: >- Partner marketing attribution, campaign analytics, and event ingestion endpoints. - name: Pipeline description: Partner-readable lead pipeline metadata. - name: Reports description: Partner report import, listing, fetch, export, and download endpoints. - name: Visualizer description: >- Partner Sales Visualizer creation, generation, hosted photo upload links, image reads, session history, and share-link endpoints. - name: Estimates description: Partner Budget Estimate creation and reads for the key-bound workspace. - name: Objects description: >- Partner Data Objects discovery, schema, records, relations, views, and admin endpoints. paths: /api/v1/budget-estimates/{estimate_id}: get: tags: - Estimates summary: Get budget estimate description: >- Returns a saved Budget Estimate in the create response shape. Only the API key that created the estimate can read it. operationId: Get budget estimate parameters: - $ref: '#/components/parameters/EstimateId' responses: '200': description: Budget Estimate found. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/BudgetEstimateResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: EstimateId: name: estimate_id in: path required: true x-docs-test-value: be_example schema: type: string minLength: 4 maxLength: 200 pattern: ^be_[A-Za-z0-9_-]+$ headers: RateLimitLimit: description: Maximum requests allowed in the current window. schema: type: string RateLimitRemaining: description: Requests remaining in the current window. schema: type: string RateLimitReset: description: ISO timestamp when the current rate-limit window resets. schema: type: string format: date-time RetryAfter: description: Seconds until the caller should retry. schema: type: string schemas: BudgetEstimateResponse: type: object additionalProperties: false required: - budget_estimate - input properties: budget_estimate: $ref: '#/components/schemas/BudgetEstimateSnapshot' input: $ref: '#/components/schemas/BudgetEstimateInput' BudgetEstimateSnapshot: type: object additionalProperties: false required: - area_sqft - roofing_squares - min_price - max_price - exact_price - price_display_mode - currency - complexity_tier - confidence - status - provider - map_lat - map_lng - disclaimer properties: estimate_id: type: string status: type: string enum: - ready - fallback description: >- `fallback` means RoofKit could not measure the roof. Show it as review required. area_sqft: type: number roofing_squares: type: number min_price: type: number max_price: type: number exact_price: type: number price_display_mode: type: string enum: - exact - range price_range_percentage: type: number price_range_type: type: string currency: type: string const: USD complexity_tier: type: string enum: - simple - moderate - complex - very_complex confidence: type: string enum: - low - medium - high provider: type: string map_lat: type: number map_lng: type: number map_zoom: type: number base_price_cents_per_sqft: type: number modifier_cents_per_sqft: type: number price_cents_per_sqft: type: number data_layer_preview_available: type: boolean disclaimer: type: string solar_estimate: type: object additionalProperties: true options: type: array items: $ref: '#/components/schemas/BudgetEstimateMaterialOption' preferred_material_id: type: string preferred_color_id: type: string preferred_manufacturer: type: string BudgetEstimateInput: type: object additionalProperties: false required: - address - place_id - lat - lng - selected_material_id - selected_shape_id - selected_color_id properties: address: type: string place_id: type: - string - 'null' lat: type: number lng: type: number selected_material_id: type: - string - 'null' selected_shape_id: type: - string - 'null' selected_color_id: type: - string - 'null' ErrorResponse: type: object additionalProperties: false required: - error properties: error: type: object additionalProperties: false required: - code - message - request_id properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string request_id: type: string details: type: object additionalProperties: true BudgetEstimateMaterialOption: type: object additionalProperties: false required: - material_key - material_id - exact_price - min_price - max_price properties: material_key: type: string material_id: type: string exact_price: type: number min_price: type: number max_price: type: number ErrorCode: type: string enum: - UNAUTHORIZED - FORBIDDEN - RATE_LIMITED - VALIDATION_ERROR - NOT_FOUND - CONFLICT - INSUFFICIENT_CREDITS - INTERNAL_ERROR responses: Unauthorized: description: Missing, malformed, revoked, deleted, or unknown API key. headers: WWW-Authenticate: schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- The API key lacks a required scope, or the workspace is not active. A scope failure names a missing scope in `details.required_scope`. When the key lookup refuses the call, `details.missing_scopes` lists every required scope that the key does not hold. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_scope: summary: A Read-only key calls a write operation value: error: code: FORBIDDEN message: 'API key does not include the required scope: leads.write.' request_id: req_123 details: required_scope: leads.write missing_scopes: - leads.write NotFound: description: Resource not found in the key-bound workspace. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' RateLimited: description: Rate limit exceeded for this key and endpoint or invalid-auth bucket. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal authentication or server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: ApiKeyBearer: type: http scheme: bearer bearerFormat: RoofKit API key description: 'Use `Authorization: Bearer rk_live_...`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.