API reference
Ask the server what it supports, which version it speaks, and who your key is.
One unauthenticated discovery call lists versions and capabilities; a header pins the version; another call names the key's organization and workspace.
What the server supports
GET /v1/uhp needs no key. It returns the protocol versions the server implements, the one it uses by default, and a capability map you can check before relying on a feature.
{
"object": "uhp.discovery",
"versions": ["2026-10-19", "2026-09-28", "2026-09-12", "2026-08-11"],
"default_version": "2026-09-28",
"capabilities": {
"streaming": true,
"session_sharing": true,
"session_branching": true,
"input_history": true,
"harness_retirement": true
}
}Pinning a version
Send UHP-Version with a date from that list, and every response is written to that version and says so in its own UHP-Version header. Without the header you get the default.
A version the server does not implement answers 400 with unsupported_protocol_version, and detail.supported lists the ones it does.
UHP-Version: 2026-10-19
Who your key is
GET /v1/me returns the organization, workspace and member a key acts as. Call it once at startup to check that a deployment holds the key you meant it to.
Ready to run this against a live workspace?Create API key