openapi: 3.2.0
info:
  title: hover-api-v3 Blueprints API
  version: '3'
servers:
- url: https://hover.to
security:
- sec0: []
tags:
- name: Blueprints
paths:
  /api/v1/blueprints:
    post:
      summary: Blueprint Upload - Build All
      description: ''
      operationId: blueprint-upload-build-all
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                current_user_id:
                  type: integer
                  description: Required. The ID value of an admin user in the authenticated Hover organization
                  default: 8675309
                  format: int32
                job:
                  properties:
                    name:
                      type: string
                      description: Required. The name of the job.
                      default: Bluth House
                    deliverable_id:
                      type: integer
                      description: Required. The ID value of the desired deliverable, type 2, 3, or 8.
                      default: 3
                      format: int32
                    file_attachments_attributes:
                      properties:
                        ? ''
                        : properties:
                            url:
                              type: string
                              description: Semi-required, this parameter or the `jobs[files]` is required. This parameter is used to reference files already hosted elsewhere (Dropbox, S3, etc.). This requires providing provider, url, filename, mimetype, and size for each file.
                              format: binary
                          description: Semi required, this or the `job[file_attachments_attributes][][url]` parameter are required. Use job[files][] parameter to upload local files directly using the file path like `@/path/to/file.pdf`. This is the recommended approach for most use cases.
                          required: []
                          type: object
                      required: []
                      type: object
                    files:
                      properties:
                        ? ''
                        : type: string
                          description: Semi required, this or the `job[file_attachments_attributes][][url]` parameter are required. Use job[files][] parameter to upload local files directly using the file path like `@/path/to/file.pdf`. This is the recommended approach for most use cases.
                      required: []
                      type: object
                    location_line_1:
                      type: string
                      description: The first line of the job's address.
                      default: 123 Hover Way
                    location_line_2:
                      type: string
                      description: The second line of the job's address.
                      default: Building 1
                    customer_name:
                      type: string
                      description: The name of the customer.
                      default: Michael Bluth
                    email_address:
                      type: string
                      description: The email address of the user assigned to the job.
                      default: michael.bluth@hover.to
                    customer_phone:
                      type: string
                      description: The phone number of a customer.
                      default: '8058675309'
                    location_city:
                      type: string
                      description: The city of the job's address.
                      default: Los Angeles
                    location_region:
                      type: string
                      description: The two character state value.
                      default: CA
                    location_postal_code:
                      type: integer
                      description: The postal code of the job's address
                      default: 90210
                      format: int32
                    external_identifier:
                      type: string
                      description: A unique identifier generated by the client.
                      default: '8675309'
                  required: []
                  type: object
                workflow:
                  type: string
                  description: Required. "build_all" - Builds all elevations.
                  default: build_all
          multipart/form-data:
            schema:
              type: object
              properties:
                current_user_id:
                  type: integer
                  description: Required. The ID value of an admin user in the authenticated Hover organization
                  default: 8675309
                  format: int32
                job:
                  properties:
                    name:
                      type: string
                      description: Required. The name of the job.
                      default: Bluth House
                    deliverable_id:
                      type: integer
                      description: Required. The ID value of the desired deliverable, type 2, 3, or 8.
                      default: 3
                      format: int32
                    file_attachments_attributes:
                      properties:
                        ? ''
                        : properties:
                            url:
                              type: string
                              description: Semi-required, this parameter or the `jobs[files]` is required. This parameter is used to reference files already hosted elsewhere (Dropbox, S3, etc.). This requires providing provider, url, filename, mimetype, and size for each file.
                              format: binary
                          description: Semi required, this or the `job[file_attachments_attributes][][url]` parameter are required. Use job[files][] parameter to upload local files directly using the file path like `@/path/to/file.pdf`. This is the recommended approach for most use cases.
                          required: []
                          type: object
                      required: []
                      type: object
                    files:
                      properties:
                        ? ''
                        : type: string
                          description: Semi required, this or the `job[file_attachments_attributes][][url]` parameter are required. Use job[files][] parameter to upload local files directly using the file path like `@/path/to/file.pdf`. This is the recommended approach for most use cases.
                      required: []
                      type: object
                    location_line_1:
                      type: string
                      description: The first line of the job's address.
                      default: 123 Hover Way
                    location_line_2:
                      type: string
                      description: The second line of the job's address.
                      default: Building 1
                    customer_name:
                      type: string
                      description: The name of the customer.
                      default: Michael Bluth
                    email_address:
                      type: string
                      description: The email address of the user assigned to the job.
                      default: michael.bluth@hover.to
                    customer_phone:
                      type: string
                      description: The phone number of a customer.
                      default: '8058675309'
                    location_city:
                      type: string
                      description: The city of the job's address.
                      default: Los Angeles
                    location_region:
                      type: string
                      description: The two character state value.
                      default: CA
                    location_postal_code:
                      type: integer
                      description: The postal code of the job's address
                      default: 90210
                      format: int32
                    external_identifier:
                      type: string
                      description: A unique identifier generated by the client.
                      default: '8675309'
                  required: []
                  type: object
                workflow:
                  type: string
                  description: Required. "build_all" - Builds all elevations.
                  default: build_all
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Blueprints
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://developers.hover.to/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.hover.to/reference/blueprint-upload-build-all.md
  - https://developers.hover.to/reference/blueprint-upload-specify-details.md
  - https://developers.hover.to/reference/check-for-existing-capture-request.md
  - https://developers.hover.to/reference/create-capture-request.md
  - https://developers.hover.to/reference/create-deliverable-change-request.md
  - https://developers.hover.to/reference/create-job-share-link-with-password.md
  - https://developers.hover.to/reference/create-note.md
  - https://developers.hover.to/reference/create-pdf-or-csv.md
  - https://developers.hover.to/reference/delete-capture-request.md
  - https://developers.hover.to/reference/delete-job-share-link.md
  - https://developers.hover.to/reference/delete-note.md
  - https://developers.hover.to/reference/delete-pending-change-order-request.md
  - https://developers.hover.to/reference/delete-webhook.md
  - https://developers.hover.to/reference/generate-access-token.md
  - https://developers.hover.to/reference/get-agreement-details-1.md
  - https://developers.hover.to/reference/get-authorization-code.md
  - https://developers.hover.to/reference/get-capture-request-link.md
  - https://developers.hover.to/reference/get-esx-export.md
  - https://developers.hover.to/reference/get-fml-export.md
  - https://developers.hover.to/reference/get-inspection-pdf-1.md
  - https://developers.hover.to/reference/get-inspection-workflow-details.md
  - https://developers.hover.to/reference/get-jobs-payment-details.md
  - https://developers.hover.to/reference/get-json-measurements.md
  - https://developers.hover.to/reference/get-measurements-pdf.md
  - https://developers.hover.to/reference/get-payment-receipt-html.md
  - https://developers.hover.to/reference/get-payment-receipt-pdf.md
  - https://developers.hover.to/reference/get-pdf-or-csv.md
  - https://developers.hover.to/reference/get-skp-export.md
  - https://developers.hover.to/reference/get-upgrade-price.md
  - https://developers.hover.to/reference/get-wireframe-images-1.md
  - https://developers.hover.to/reference/get-xlsx-measurements.md
  - https://developers.hover.to/reference/get-xml-3d-export.md
  - https://developers.hover.to/reference/invite-user.md
  - https://developers.hover.to/reference/list-available-deliverables.md
  - https://developers.hover.to/reference/list-capture-requests.md
  - https://developers.hover.to/reference/list-deliverable-change-requests.md
  - https://developers.hover.to/reference/list-estimates.md
  - https://developers.hover.to/reference/list-instant-design-images.md
  - https://developers.hover.to/reference/list-instant-design-leads.md
  - https://developers.hover.to/reference/list-job-share-links.md
  - https://developers.hover.to/reference/list-jobs.md
  - https://developers.hover.to/reference/list-notes.md
  - https://developers.hover.to/reference/list-organization-tree.md
  - https://developers.hover.to/reference/list-payments.md
  - https://developers.hover.to/reference/list-users.md
  - https://developers.hover.to/reference/list-wallets.md
  - https://developers.hover.to/reference/list-webhooks.md
  - https://developers.hover.to/reference/multi-structure-test-jobs.md
  - https://developers.hover.to/reference/re-assign-requesting-user.md
  - https://developers.hover.to/reference/refresh-access-token.md
  - https://developers.hover.to/reference/register-webhook.md
  - https://developers.hover.to/reference/remove-user-from-org.md
  - https://developers.hover.to/reference/resend-capture-request-notifications.md
  - https://developers.hover.to/reference/resend-webhook-verification-code.md
  - https://developers.hover.to/reference/send-invitation-email.md
  - https://developers.hover.to/reference/share-inspection-workflow.md
  - https://developers.hover.to/reference/show-capture-request-details.md
  - https://developers.hover.to/reference/show-estimate-details.md
  - https://developers.hover.to/reference/show-instant-design-image.md
  - https://developers.hover.to/reference/show-instant-design-lead.md
  - https://developers.hover.to/reference/show-job-details.md
  - https://developers.hover.to/reference/show-job-share-link.md
  - https://developers.hover.to/reference/show-organization-details.md
  - https://developers.hover.to/reference/show-user-profile.md
  - https://developers.hover.to/reference/update-a-job.md
  - https://developers.hover.to/reference/update-job-share-link.md
  - https://developers.hover.to/reference/update-job-test-state-single-structure.md
  - https://developers.hover.to/reference/update-note.md
  - https://developers.hover.to/reference/update-organization.md
  - https://developers.hover.to/reference/verify-webhook.md
  merge:
    pages: 70
    deduped: 69
    conflicts_kept_first: 0