Docs Sign in Start building

Approve one export of a wire request

wire.request.approve

An administrator lets one request file leave the box: it writes an approval row, operation wire.request.export, whose arguments name the run, the scope and the BRD digest, with your decision on it. scope is redacted unless you name full: a redacted file carries the BRD's title, digest and requirement ids and each change request's id and sentence, and full adds the BRD's text and each change request's note. You hold desk.settings.manage across every Product and you did not send the request; else it refuses approval_decider_refused naming who can approve. From a CLI login or a personal access token you give your password, as approval.decide asks. One approval answers one export within a day; a second approval on the run while one waits returns the waiting one as ended and opens yours. Callers: the account owner's CLI login, or an agent token with blueprints:write, or a personal access token with blueprints:write.

POST /v1/wire/runs/{runId}/request/approvals

Principal user_session. Idempotency required. Environment sandbox.

Input

FieldInTypeDescription
runId requiredpathstringWire run ID, such as wrn_sandbox_...
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
scopebodyredacted | fullredacted: the BRD's title, digest and requirement ids and each change request's id and sentence. full: the BRD's text and each change request's note as well
passwordbodystringYour password, required when you approve from a CLI login or a personal access token

Output

FieldTypeDescription
tenantId requiredstringOrganization tenant ID
approvalId requiredstringThe approval row the export consumes
runId requiredstringWire run ID, such as wrn_sandbox_...
scope requiredredacted | fullredacted: the BRD's title, digest and requirement ids and each change request's id and sentence. full: the BRD's text and each change request's note as well
brdDigest requiredstring
requestedBy requiredstringThe user id of the member who sent the request
approvedBy requiredstringYour user id
expiresAt requiredstringWhen the approval lapses unexported, a day after it

Request sample

Only a signed-in person may call this: the CLI after hyperscale auth login, or curl with a personal access token (hyperscale_pat_...) with blueprints:write or an agent token with blueprints:write. The agent's grant must span every Product the call reads. 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/wire/runs/resource_sandbox_example0001/request/approvals' \
  --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"}'

CLI

hyperscale api call wire.request.approve \
  --input '{"runId":"resource_sandbox_example0001","tenantId":"ten_sandbox_example0001"}'

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, and a program action under `requires approval` waits on distinct people other than the maker.
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.
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.
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.
approval_decider_refused403The decider made the call, already decided this approval from some session, or holds no authority for the step it waits on. Nothing changed.
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.
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