Skip to content
Hayonix

API reference · Schema

Caller

  • objectstringrequired

    Always `caller`: the type of this object

    One ofcaller

  • credentialstringrequired

    How the request authenticated: a project API key or a console session

    One ofapi_keysession

  • org_idstringrequired

    Organization it belongs to

    ID with prefix org_

  • project_idstringrequired

    Project it belongs to

    ID with prefix prj_

  • api_key_idstring | nullrequired

    The API key that made the request; null for a session

    ID with prefix key_

  • user_idstring | nullrequired

    The signed-in user; null for an API key

    ID with prefix usr_

  • permissionsarray of stringrequired

    Actions (`resource:verb`) the credential may perform in this project: the key’s scopes, or the role’s permissions for a session. The server authorises every request regardless.

Example
{
  "object": "caller",
  "credential": "api_key",
  "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "api_key_id": "key_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "user_id": "usr_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "permissions": [
    "pod:read",
    "inference:invoke"
  ]
}

Used by