AI Workforce OneHQDocs

Essentials

Health, the contract itself, and the calling credential.

Check the API is up

GET/v1/health
Permission No key needed

No credential needed. version is the deployed build.

Returns a Health object.

Responses
200

The API is serving.

Other

An RFC 9457 problem.

Get this contract

GET/v1/openapi.json
Permission No key needed

The OpenAPI 3.1 document this server implements, as JSON. No credential needed.

Responses
200

The OpenAPI document.

Other

An RFC 9457 problem.

Describe the calling key

GET/v1/me
Permission Any valid key

The key making this request, its organization, scopes, version and expiry.

Headers
HQ-Versionstring (date)

A dated API version. Defaults to the version the key was created with.

HQ-Accountstring

Agency keys only: the slug of the client organization this request acts for. Required with an agency key, refused with 400 invalid_request on any other credential. A slug that is not one of your agency's current clients is 404 not_found. An agency key is limited to 600 requests a minute per key on EACH API server (the cap is per replica), plus its own budget per client (limit_scope: agency_client), separate from the client's own keys.

Returns a Credential object.

Responses
200

The calling credential.

Other

An RFC 9457 problem.

Objects

Health

Attributes
okbooleanrequired
versionstringrequired

The deployed image digest.

Credential

Attributes
objectstring
idstring

The key's id (key_…), or for an OAuth app the grant's (grant_…).

kindstring

Open-ended; more credential kinds may be added.

namestring

The key's name, or the OAuth app's.

appobject

Present for an OAuth app only.

orgobject

The organization this request acts in. For an agency key, the client named in HQ-Account.

agencyobject

Present for an agency key only. The agency the key belongs to.

acting_userobject or null

The member a user key or an OAuth app acts as. Null for a service key or an agency key.

rolestring or null

A service key's role, or an agency key's (always sys:admin).

scopesarray of string
team_scopestring

One of all, selected.

teamsarray of string or null
api_versionstring (date)
expires_atstring (date-time)