Rewind the sandbox company to a snapshot

company.rewind.create

Puts a sandbox company back to a snapshot it took, in one operation. Products' clocks and states, business objects, records of agreements and their hold receipts, and due Work return to the snapshot's checkpoint: rows created after it are deleted, the rest rewritten. The ledger is never edited: each hold reserved after the checkpoint is voided, and each account whose posted balance moved gets one transfer_adjust against the company's sandbox funding account, or another account of the same book and currency when it has none. Records, bank statements, closes, agent grants, approvals, tasks, consents, keys and the operation, receipt and audit history stay, and the artefact lists them under kept. Refuses before any write: in live (sandbox_environment_required), a snapshot taken without a checkpoint (rewind_point_missing), a close stored after the snapshot (rewind_closed_period), a hold the checkpoint held that has since posted, voided or partly posted (rewind_hold_resolved), a hold waiting on a provider's answer (reservation_call_pending), a Product promoted, added or rebuilt since (rewind_product_changed), a ledger account opened since (rewind_account_opened) and money that left the company since (rewind_ledger_unbalanced). Also refuses while any other operation in the company is unresolved. Rehearse it to read the plan without a write. Callers: the founder's CLI login, or an agent token with products:write.

POST /v1/company-rewinds

Principal user_session. Idempotency required. Environment either.

Input

Field	In	Type	Description
`X-Hyperscale-Environment`	header	`sandbox \| live`
`Idempotency-Key` required	header	`string`
`X-Hyperscale-Rehearsal`	header	`"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` required	body	`string`	Organization tenant ID
`reportingArtifactId` required	body	`string`	The company snapshot to put the company back to. It must be a sandbox snapshot taken with a checkpoint.

Request sample

curl --request POST 'https://hyperscale0.ai/v1/company-rewinds' \
  --header "Authorization: Bearer $HYPERSCALE_API_KEY" \
  --header 'X-Hyperscale-Environment: sandbox' \
  --header "Idempotency-Key: $(uuidgen)" \
  --header 'Content-Type: application/json' \
  --data-raw '{"tenantId":"ten_sandbox_example0001","reportingArtifactId":"rpt_sandbox_example0001"}'

Errors

Code	HTTP	Cause
`agent_approval_denied`	403	A human denied the agent's proposed operation.
`agent_approval_required`	202	An agent proposed a protected live operation.
`agent_cap_exceeded`	202	A capped agent's call would move more than its grant allows per operation, per rolling day or per rolling 30 days.
`agent_reason_required`	400	An agent sent a change without saying why, or the reason is shorter than 8 or longer than 280 characters.
`agent_result_already_delivered`	409	A caller already claimed this approval's one-time result.
`csrf_token_invalid`	403	A browser session mutation did not carry a current Hyperscale CSRF token.
`environment_mismatch`	403	The session was issued for sandbox or live and the request targets the other environment.
`idempotency_conflict`	409	The request reused an Idempotency-Key for a different logical mutation.
`idempotency_required`	400	The operation is a mutation and Hyperscale requires a replay key before executing it.
`internal_error`	500	Hyperscale hit an unexpected server-side condition and hid internal implementation details from this audience.
`invalid_request`	400	The request does not match the API reference.
`missing_required_permission`	403	The signed-in member's current role does not grant the permission required for this operation.
`missing_required_scope`	403	The credential is valid but does not grant one or more operation scopes.
`not_found`	404	No Hyperscale route matched the requested path and method.
`product_access_suspended`	403	The Product is disabled or closed, so its credentials are suspended in every environment.
`product_activation_required`	403	The live Product or required live capability is not active yet.
`rate_limited`	429	The 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_large`	413	The JSON request body exceeded Hyperscale's accepted payload size.
`resource_not_found`	404	The requested resource does not exist in the credential's visible scope.
`state_conflict`	409	The operation conflicts with the current durable state of the resource.
`state_constraint_failed`	422	The request is syntactically valid but violates a business-state constraint.
`tenant_mismatch`	403	The request mixed tenant-owned identifiers across tenant boundaries.
`tenant_not_found`	404	The credential resolved to a tenant Hyperscale cannot find.
`unauthorized`	403	The request did not include a valid Hyperscale bearer credential for this environment.
`agent_token_expired`	401	The 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_replaced`	401	The founder 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.
`company_period_closed`	409	The company already closed this period in this environment. A period closes once and the close never changes. In sandbox a money operation dated by its Product clock inside a closed month refuses too, so the close's VAT return and journal stay whole; `details.period` names the month.
`cross_tenant_transfer_forbidden`	409	An account on this transfer belongs to another tenant, or it has no tenant and is not a platform account. `details.accountId` names it. No intent or ledger effect was created.
`currency_mismatch`	400	The currency on the request does not match the settlement currency of the account or transfer it targets. Hyperscale never converts between currencies, so the two must be identical.
`device_login_expired`	401	The bearer is the founder'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.
`instrument_instance_not_found`	404	No record of this instrument matches the `instanceId` in this Product, company and environment. `details.instrumentId` and `details.instrumentInstanceId` name what was looked up.
`insufficient_balance`	409	The source (debit) account's available balance is below the transfer amount, so the ledger refused the transfer. No money moved. The transfer was not created and its charge/transfer rows are recorded as failed.
`invalid_credentials`	401	Hyperscale 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.
`ledger_transfer_rejected`	409	The ledger refused the transfer for a reason other than insufficient balance. No money moved. `details` carries `transferId`, the debit-side `accountId`, `amount` and `currency`. The ledger's own reason stays in the server log.
`ledger_unavailable`	503	The ledger could not be reached, did not answer in time, or returned incomplete evidence for the accounts this request reads. `details.reason` is `request_timeout` when the call timed out.
`operation_not_finalized`	409	The 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.
`reporting_artifact_refused`	422	The capture could not be complete: an operation in the company is still unresolved, or the result passes the row limit.
`reporting_capture_timeout`	503	The capture ran past its time bound before it finished reading.
`reservation_call_pending`	409	A hold is waiting on a provider's answer to a capture or void. A rewind cannot put the hold back while the provider may still settle it. Nothing changed.
`rewind_account_opened`	409	A ledger account opened after the checkpoint. The ledger keeps every account it opens, so the company cannot go back to a point before it existed. Nothing changed.
`rewind_closed_period`	409	The company closed a month after this snapshot was taken. A month closes once, and a rewind past the close would change what the close recorded. Nothing changed.
`rewind_hold_resolved`	409	A hold the checkpoint held has since posted, voided, expired or partly posted. A rewind never reserves a hold again, because the money it held has moved. Nothing changed.
`rewind_ledger_unbalanced`	409	Money left the company after the checkpoint, to an account the company does not own, such as a platform fee. A rewind compensates only between the company's own accounts, so it cannot return that money. Nothing changed.
`rewind_point_missing`	409	The snapshot has no checkpoint. Live snapshots never store one, and sandbox snapshots from before r390 did not. Nothing changed.
`rewind_product_changed`	409	A Product was promoted to live, added or given a new Build after the snapshot. A rewind keeps Builds, promotions and Products, so it cannot put the company back past them. `details.reason` is `promoted`, `added` or `rebuilt`. Nothing changed.
`sandbox_environment_required`	400	This operation runs only in sandbox. That covers Product creation and composition, enabling capabilities, composition-scoped API keys, rehearsal Products and provider webhook simulation.
`session_expired`	401	The 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_required`	401	This 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_revoked`	401	The 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_forbidden`	409	The company is suspended or closed, so every credential bound to it is refused, reads included. `details.tenantId` names the company.

All operations