API reference · Schema
Caller
objectstringrequiredAlways `caller`: the type of this object
One of
callercredentialstringrequiredHow the request authenticated: a project API key or a console session
One of
api_keysessionorg_idstringrequiredOrganization it belongs to
ID with prefix org_
project_idstringrequiredProject it belongs to
ID with prefix prj_
api_key_idstring | nullrequiredThe API key that made the request; null for a session
ID with prefix key_
user_idstring | nullrequiredThe signed-in user; null for an API key
ID with prefix usr_
permissionsarray of stringrequiredActions (`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"
]
}