TEE Docker API reference

Base URL, authentication, error shape, and request tracing — the conventions every endpoint shares.

Everything shared by every endpoint lives here, so the per-resource pages can stay short.

Base URL

https://tee-api.hypetrade.xyz/v1

Every route is prefixed with /v1. Request bodies are JSON and need content-type: application/json.

Authentication

Two tiers. Which one a route takes is stated on every endpoint.

-H "X-Api-Key: $API_KEY" -H "X-Api-Secret: $API_SECRET"

Used by exactly five routes: workspace create, list, and delete; quota; and token mint. Missing or wrong credentials return 401 with bad_api_key.

-H "Authorization: Bearer $TOKEN"

Used by everything else. The workspace comes from the token’s own claim — no route on this tier takes a :workspace path parameter, so a path and a token can never disagree.

Scopes

Workspace-token routes additionally require a scope: read, write, sign, or export. A valid token used outside its scopes returns 403 with scope_denied. See Scopes and permissions.

Error shape

Every error, from every route, has one shape:

{
  "error": {
    "code": "account_not_found",
    "message": "…",
    "status": 404,
    "requestId": "…"
  }
}

Branch on error.code, never on message — messages are for humans and may change. Keep requestId when reporting a problem to your operator.

The full catalog of codes, grouped by status, is on the Errors page.

Request tracing

Send your own correlation id and it will be echoed back:

-H "X-Request-ID: my-trace-id-123"

Accepted when it is 1–128 characters of letters, digits, dots, underscores, or hyphens. If it is missing or unsafe, the service generates a safe one instead. Either way the id appears in the response header and in error.requestId.

Status codes

Status	Meaning here
`200`	Success with a body
`201`	Created — workspaces, tokens, accounts, wallets
`202`	Accepted for submission, not confirmed — transaction send only
`204`	Success, no body — deletes, lock, unlock, token revoke
`4xx`	Your request; see the code
`5xx` / `502` / `504`	The service or an upstream RPC endpoint

x-rpc-source is stamped on chain-touching responses, naming which endpoint tier served the call — see Networks and RPC.

The endpoints

Page	Covers
Health	Liveness
Auth	Mint, refresh, revoke tokens
Workspaces	Tenant-tier workspace administration and quota
Workspace	Current workspace, account listing, assets, lock and unlock
Accounts	Accounts, wallets, addresses, tags
Networks	Network list and RPC endpoint registration
Sign	Message and typed-data signing
Transactions	Build, simulate, send, status
Addresses	Balance lookup (not available in this release)
Export	Sealed mnemonic and private-key export