Workspace

Workspace Rules

GEThttps://api.vaakyo.com/api/v1/guardrails/rules

The platform rules every agent must follow (enabled ones), and how strikes work.

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the agents.view permission.

X-API-KeyAuthorization: Beareragents.view

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

429Over the per-key rate limit; wait for Retry-After.

detailstring

What went wrong, in plain words.

curl --request GET \
  --url 'https://api.vaakyo.com/api/v1/guardrails/rules?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.vaakyo.com/api/v1/guardrails/rules"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}

response = requests.get(url, params=params, headers=headers)
print(response.status_code, response.json())

const response = await fetch("https://api.vaakyo.com/api/v1/guardrails/rules?timezone=Asia/Kolkata", {
  headers: {
    "X-API-Key": "<api-key>",
  },
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (agents.view)"
}

{
  "detail": "rate limit exceeded; slow down"
}