Workspace

Appeal

POSThttps://api.vaakyo.com/api/v1/guardrails/incidents/{incident_id}/appeal

Ask the platform team to review an incident (a note: why it’s wrong, or what was fixed).

Authorization

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

X-API-KeyAuthorization: Beareragents.edit

Path parameters

incident_idstringrequired

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.

Body application/json

notestringrequired

why the incident is wrong or fixed

10 to 2000 characters

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.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

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

detailstring

What went wrong, in plain words.

curl --request POST \
  --url 'https://api.vaakyo.com/api/v1/guardrails/incidents/{incident_id}/appeal?timezone=Asia/Kolkata' \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "note": "notexxxxxx"
}'

import requests

url = "https://api.vaakyo.com/api/v1/guardrails/incidents/{incident_id}/appeal"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "X-API-Key": "<api-key>",
}
payload = {
    "note": "notexxxxxx",
}

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

const response = await fetch("https://api.vaakyo.com/api/v1/guardrails/incidents/{incident_id}/appeal?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "note": "notexxxxxx"
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

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

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}

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