View Markdown

Observability

Your own usage, request logs and delivery timelines.

Generated from the contract, version 2.0.0-draft.2 (OpenAPI). Base URL https://usekabu.com/api. Errors are problem details, each code with its own page.

Delivery timeline for a message

GET/v2/messages/{message_id}/deliveries
  • Auth: an API key, or a signed-in human’s token (the Kabu apps).
  • Scopes: observability:read.
  • Signed-in humans: admin.
Parameter In Type Required Description
message_id path string Required A msg_… id.
limit query integer, from 1 to 100 Optional
after query string Optional Opaque cursor from next_cursor.
Kabu-Org header string Optional Select a live membership (default personal org); non-member is 404. Human tokens are live-only. Caller user id is distinct from billing owner.
Status Means Body
200 OK DeliveryAttemptList
4XX Error Problem
5XX Error Problem
curl "https://usekabu.com/api/v2/messages/$MESSAGE_ID/deliveries" \
  -H "Authorization: Bearer $KABU_API_KEY"

Usage against plan limits, per agent

GET/v2/usage
  • Auth: an API key, or a signed-in human’s token (the Kabu apps).
  • Scopes: usage:read.
  • Signed-in humans: member.
Parameter In Type Required Description
project query string Optional
Kabu-Org header string Optional Select a live membership (default personal org); non-member is 404. Human tokens are live-only. Caller user id is distinct from billing owner.
Status Means Body
200 OK Usage
4XX Error Problem
5XX Error Problem
curl "https://usekabu.com/api/v2/usage" \
  -H "Authorization: Bearer $KABU_API_KEY"

Your recent API requests (24 h, metadata only)

GET/v2/request_logs
  • Auth: an API key, or a signed-in human’s token (the Kabu apps).
  • Scopes: observability:read.
  • Signed-in humans: admin.
Parameter In Type Required Description
limit query integer, from 1 to 100 Optional
after query string Optional Opaque cursor from next_cursor.
status query integer Optional
route query string Optional
request_id query string Optional
Kabu-Org header string Optional Select a live membership (default personal org); non-member is 404. Human tokens are live-only. Caller user id is distinct from billing owner.
Status Means Body
200 OK RequestLogList
4XX Error Problem
5XX Error Problem
curl "https://usekabu.com/api/v2/request_logs" \
  -H "Authorization: Bearer $KABU_API_KEY"

Schemas

DeliveryAttemptList

Property Type Required Description
object "list" Required
data array of DeliveryAttempt Required
has_more boolean Required
next_cursor string or null Required

DeliveryAttempt

Property Type Required Description
channel Channel Required Open enum. Known values are ChannelKnown; accept and ignore unknown values.
recipient string Required
status string Required
detail string or null Required
at Timestamp Required

Usage

Property Type Required Description
object "usage" Required
plan string Required
period_start Timestamp Required
period_end Timestamp Required
messages UsageCounter Required
open_asks UsageCounter Required
waits UsageCounter Required
media_bytes UsageCounter Required
tts_characters UsageCounter Required
by_agent array of object, at most 50 items Required Top 50 agents by messages; the full breakdown belongs to reports.
by_agent[].agent string Required
by_agent[].messages integer Required
by_agent[].asks integer Required

UsageCounter

Property Type Required Description
used integer Required
limit integer or null Required

RequestLogList

Property Type Required Description
object "list" Required
data array of RequestLog Required
has_more boolean Required
next_cursor string or null Required

RequestLog

Metadata only: never bodies, secrets or links. Kept 24 h.

Property Type Required Description
request_id string Required
method string Required
route string Required
status integer Required
duration_ms integer Required
key string or null Required
trace_id string or null Required
code string or null Required
at Timestamp Required