Docs Sign in Start building

Export the inspector's file for a range of dates

box.inspection.export

Writes the evidence file a regulator's inspector asks for, hyperscale.evidence.v2 with a box subject, that `hyperscale inspect verify` checks offline against the instance public key in the box's /release.json. Its records, each stored once by SHA-256 under a manifest the Assure key signs and the instance key endorses: the Core register, every version of every Product saved before the range ends, with its number, the gate signatures on its digest, the diff from the version before and, for a live Core, its promotion; the releases Arc started serving on the box; every approval decided in the range with the member behind each decision; every month closed in the range, its close record whose bytes hash to the close's digest and the manifestDigest of each file taken from it; every alert firing and clearing; the ops/events.jsonl lines the installer and `hyperscale keys rotate` wrote in the range, a key named by name and time only; ops/drill-status/last.json, the restore drill's last run; the range's audit events in chain order between the chain heads the instance stores; and every access event in the range, each email and credential by fingerprint. `redacted: true` leaves out each audit event's body and each access event's client address and host. A range that ends at or before it starts refuses with inspection_range_empty. The audit row box.inspection.exported names you, the range and the file's manifestDigest. Callers: the account owner's own CLI login (`hyperscale auth login`), or a personal access token with activity:read. An agent token is refused.

POST /v1/box-inspections/evidence

Principal user_session. Idempotency required. Environment either.

Input

FieldInTypeDescription
X-Hyperscale-Environmentheadersandbox | live
Idempotency-Key requiredheaderstring
X-Hyperscale-Rehearsalheader"true"`true` runs the request through admission and execution, keeps nothing, and answers OperationRehearsal with 200 in place of the operation's own output. Needs a signed-in caller. Identity operations, such as sign-in, sessions, team members and agent grants, refuse it with invalid_request.
tenantId requiredbodystringOrganization tenant ID
from requiredbodystring | stringThe first instant of the range, inclusive: a date, read as 00:00 UTC, or an instant.
to requiredbodystring | stringThe end of the range, exclusive: a date, read as 00:00 UTC, or an instant. It must follow from.
redactedbodybooleanLeave out each audit event's body and each access event's client address and host, keeping fingerprints only. Send it for a file that leaves the bank.

Output

FieldTypeDescription
tenantId requiredstringOrganization tenant ID
from requiredstring
to requiredstring
redacted requiredboolean
manifestDigest requiredstringThe file's manifestDigest, the bytes its signature covers; the audit row names the same digest.
exportedBy requiredstringYour user id.
filename requiredstringinspection-<from>-<to>.json
sha256 requiredstringSHA-256 of content's UTF-8 bytes.
sizeBytes requiredinteger
content requiredstringThe evidence file, hyperscale.evidence.v2 with a box subject, as JSON with two spaces of indent and a closing newline.

Request sample

Only a signed-in person may call this: the founder's own CLI after hyperscale auth login, or curl with a personal access token (hyperscale_pat_...) with activity:read. A Product key cannot, so the SDK, which signs in with a Product key or a customer session, has no sample for it.

curl

curl --request POST 'https://hyperscale0.ai/v1/box-inspections/evidence' \
  --header "Authorization: Bearer $HYPERSCALE_TOKEN" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header "Idempotency-Key: $(uuidgen)" \
  --header 'Content-Type: application/json' \
  --data-raw '{"tenantId":"ten_sandbox_example0001","from":"2026-01-01","to":"2026-02-01"}'

CLI

hyperscale api call box.inspection.export \
  --input '{"tenantId":"ten_sandbox_example0001","from":"2026-01-01","to":"2026-02-01"}'

Errors

CodeHTTPCause
agent_reason_required400An agent sent a change without saying why, or the reason is shorter than 8 or longer than 280 characters.
agent_result_already_delivered409A caller already claimed this approval's one-time result.
approval_rejected403A person rejected the call or returned it to the maker, so it never runs.
approval_required202The call waits for decisions: an agent's call over its grant waits on its delegator, a program action under `requires approval` waits on distinct people other than the maker, and a self-hosted box's system-key write waits on a second member who holds desk.settings.manage across every Product, never its operator.
csrf_token_invalid403A browser session mutation did not carry a current Hyperscale CSRF token.
environment_mismatch403The session was issued for sandbox or live and the request targets the other environment.
idempotency_conflict409The request reused an Idempotency-Key for a different logical mutation.
idempotency_required400The operation is a mutation and Hyperscale requires a replay key before executing it.
internal_error500Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience.
invalid_request400The request does not match the API reference.
method_not_allowed405The route exists, but not for the request's HTTP method.
missing_required_permission403The signed-in member's current role does not grant the permission required for this operation.
missing_required_scope403The credential is valid but does not grant one or more operation scopes.
not_found404No Hyperscale route matched the requested path and method.
oauth_client_not_admitted403The bearer is an OAuth client token, and this operation does not admit the oauth2_client principal.
product_access_suspended403The Product is disabled or closed, so its credentials are suspended in every environment.
product_activation_required403The live Product or required live capability is not active yet.
rate_limited429The credential sent more than its limit in the current 60-second window: 600 requests per API key or session, 1,200 per IP address. Every response carries `x-ratelimit-limit`, `x-ratelimit-remaining` and `x-ratelimit-reset` (Unix seconds).
request_body_too_large413The JSON request body exceeded Hyperscale's accepted payload size.
resource_not_found404The requested resource does not exist in the credential's visible scope.
state_conflict409The operation conflicts with the current durable state of the resource.
state_constraint_failed422The request is syntactically valid but violates a business-state constraint.
tenant_mismatch403The request mixed tenant-owned identifiers across tenant boundaries.
tenant_not_found404The credential resolved to a tenant Hyperscale cannot find.
unauthorized403The request did not include a valid Hyperscale bearer credential for this environment.
upgrading503The box is installing a release and replays its stored Cores on it first, for up to 300 seconds. Writes wait for the replay, so a release it refuses rolls back with nothing written.
agent_token_expired401The agent token is real, but its grant ended. A grant lasts 30 days, or 7 days unused. `details.expiresAt` holds the date in ISO 8601 and `details.agentName` names the agent.
agent_token_replaced401The account owner ran `hyperscale agent setup` again for this agent, which replaced this token with a newer one. `details.agentName` names the agent and `details.replacedAt` holds the date.
device_login_expired401The bearer is the account owner's own device login from `hyperscale auth login`, not an agent token. Its access token lasts an hour and the CLI refreshes it; the login itself ends after 30 days, or 7 days unused. `details.expiresAt` holds when it ended in ISO 8601.
inspection_range_empty422The range's to is at or before its from, so it holds no instant to export.
instrument_instance_not_found404No record of this instrument matches the `instanceId` in this Product, company and environment. `details.instrumentId` and `details.instrumentInstanceId` name what was looked up.
invalid_credentials401Hyperscale could not accept the account or credential request. Signup, login, and bearer authentication use one 401 for every case they reject, so the response exposes no credential-specific reason or registered-email verdict. The single exception is a key that is real but homed in the other environment: because the presented secret already matched a stored key, the message names the mismatch instead of leaving a working credential looking unknown. A bearer that matched nothing gets text that fits its prefix (an agent token, a refresh token, a personal access token, a session or no Hyperscale token at all), which says only what the caller sent, never whether a credential like it exists.
operation_not_finalized409The operation in `details.operationId` has started but has no final receipt. It is still running, or its outcome is unknown after a failure past the point where it may have committed. `details.error` carries the underlying failure when there is one.
session_expired401The session behind this request has ended. A console session ends 30 days after sign-in, or after 12 hours with no request. An admin or customer session ends 24 hours after sign-in, or after 15 minutes with no request. A personal access token ends at the `expiresAt` set when it was created.
session_required401This operation needs a person signed in through the browser or the `hyperscale` CLI. A Product API key cannot call it. The request carried no session, or its token matched no live session.
session_revoked401The session or personal access token behind this request was ended before its expiry. Sign-out, `user.session.revoke`, a password reset, a role change, removal from the team, user suspension and `personal_access_token.revoke` all end sessions.
tenant_status_forbidden409The company is suspended or closed, so every credential bound to it is refused, reads included. `details.tenantId` names the company.

All operations