Skip to main content
Upload an attachment
The Hive Inspect API is a work in progress. It is available to a small group of accounts today, and the release for everyone is coming very soon.

Authorizations

Authorization
string
header
required

Your API key from Business Tools → API Access.

Path Parameters

inspectionId
string<uuid>
required

Body

multipart/form-data
kind
enum<string>
required
Available options:
report,
document
file
file

Required for a document; optional for a report. Documents: up to 10 MB. Reports: up to 25 MB.

name
string

Report name. Required for a report.

description
string

Report description. May contain a link.

internal_only
boolean

Documents only. true keeps the document inspector-only, hidden from the client.

Response

Created

id
string
inspection_id
string<uuid>
kind
enum<string>

report: an Additional Report. document: an Additional Document.

Available options:
report,
document
name
string | null
description
string | null
filename
string | null
content_type
string | null
size_bytes
integer | null
url
string | null

Signed download link, valid for 1 hour. Null for a report with no file.

visible_to_client
boolean

false for inspector-only documents

created_at
string<date-time> | null
updated_at
string<date-time> | null
Last modified on October 2, 2026