DOCUMENTATIONv2

GET

Workspace Management

Get workspace seed

/api/v2/workspaces/{id}/custody-ceremonies

AUTHENTICATIONBearer token · workspaces:readAUTHORITATIVE OWNERdark-meshCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable

PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Inspect custody-ceremony metadata planned for one workspace without exposing a seed, key share, or signing secret.

WHEN THIS CALL IS USEFUL

Do not call this planning contract in production. Once implemented, it will support custody-readiness and lifecycle reconciliation for an MPC-isolated workspace.

OUTCOME · Planned custody inspection

What changes

No executable public route exists. A future read would expose commitments and lifecycle status only; despite the legacy title, it must never return a workspace seed.

WHY IT MATTERS

Will allow agents to explain whether custody setup is prepared, pending, superseded, or active without handling secret material.
Keeps custody evidence tied to one workspace and network boundary.

ISOLATION + AUTHORITY

The future projection is workspace- and network-bound and commitment-only. Secret custody material remains exclusively inside its owning ceremony and participant systems.

BEFORE YOU CALL

Future workspaces:read authority and active workspace membership.
An implemented operation in the live production OpenAPI document.

WHAT TO DO NEXT

Use the live OpenAPI document to detect future availability.
Continue with implemented workspace and wallet-readiness routes meanwhile.

AGENT GUIDANCE

Do not register or call this route until it appears in live OpenAPI.
Never ask a user or service to provide seed phrases, private keys, MPC shares, recovery secrets, or signing nonces to satisfy this contract.
Use future commitment and readiness fields as evidence, not as signing authority.

MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing workspaces:read authority.EXAMPLEBearer hc_live_…

idpathRequired

identifierCanonical id.EXAMPLEid-01

cursorqueryOptional

opaque stringCursor returned by the previous page.EXAMPLEeyJvZmZzZXQiOjUwfQ

limitqueryOptional

integer · 1–200Maximum records to return.EXAMPLE50

statusqueryOptional

stringOptional lifecycle-state filter.EXAMPLEACTIVE

qqueryOptional

string · max 200Optional application search term.EXAMPLEtreasury

RESPONSES

Status and payload examples

200Canonical resource projection.Not executable · JSON RESPONSE+

{
  "result": "See the operation's authoritative OpenAPI response schema."
}

INTEGRATION DECISION

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

401Bearer credential is missing, expired, or invalid.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

403The principal lacks the required scope, role, tenant, or step-up authority.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The principal lacks the required scope, role, tenant, or step-up authority."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

422Path, query, or body validation failed.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+

{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}

INTEGRATION DECISIONrequest_failed

CALLER ACTION: Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY: Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION: No runtime state exists to reconcile for this planning contract. Continue from owner-scoped wallet inventory, custody policy, balances, intents, reservations, transactions, and receipts through an implemented operation.
ESCALATE WHEN: Escalate when funds, reservations, transaction digests, or MPC state remain ambiguous after authoritative wallet and network reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

GET/api/v1/workspaces/seedWORKSPACE: Get Workspace Seed

DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory ↗