Search docs

    Get the app
    View Markdown

    Agents

    Who is asking.

    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.

    List agents

    GET/v2/agents
    • Auth: an API key, or a signed-in human’s token (the Kabu apps).
    • Scopes: messages:read.
    • Signed-in humans: member.
    Parameter In Type Required Description
    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 AgentList
    4XX Error Problem
    5XX Error Problem 
    curl "https://usekabu.com/api/v2/agents" \
  -H "Authorization: Bearer $KABU_API_KEY"

    Create a agent

    POST/v2/agents
    • Auth: an API key, or a signed-in human’s token (the Kabu apps).
    • Scopes: agents:write.
    • Signed-in humans: admin.
    Parameter In Type Required Description
    Idempotency-Key header string, at most 255 characters Optional Retry-safe key. For messages, sessions and responses it binds to the created object for its life; elsewhere for 24 h.
    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.

    Request body: AgentWrite.

    Status Means Body
    201 OK Agent
    4XX Error Problem
    5XX Error Problem 
    curl -X POST "https://usekabu.com/api/v2/agents" \
  -H "Authorization: Bearer $KABU_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

    Get a agent

    GET/v2/agents/{agent}
    • Auth: an API key, or a signed-in human’s token (the Kabu apps).
    • Scopes: messages:read.
    • Signed-in humans: member.
    Parameter In Type Required Description
    agent path string Required An id or slug.
    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 Agent
    4XX Error Problem
    5XX Error Problem 
    curl "https://usekabu.com/api/v2/agents/$AGENT" \
  -H "Authorization: Bearer $KABU_API_KEY"

    Update a agent

    PATCH/v2/agents/{agent}
    • Auth: an API key, or a signed-in human’s token (the Kabu apps).
    • Scopes: agents:write.
    • Signed-in humans: admin.
    Parameter In Type Required Description
    agent path string Required An id or slug.
    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.

    Request body: AgentWrite.

    Status Means Body
    200 OK Agent
    4XX Error Problem
    5XX Error Problem 
    curl -X PATCH "https://usekabu.com/api/v2/agents/$AGENT" \
  -H "Authorization: Bearer $KABU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

    Delete a agent

    DELETE/v2/agents/{agent}
    • Auth: an API key, or a signed-in human’s token (the Kabu apps).
    • Scopes: agents:write.
    • Signed-in humans: admin.
    Parameter In Type Required Description
    agent path string Required An id or slug.
    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
    204 Done
    4XX Error Problem
    5XX Error Problem 
    curl -X DELETE "https://usekabu.com/api/v2/agents/$AGENT" \
  -H "Authorization: Bearer $KABU_API_KEY"

    Schemas

    AgentList

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

    AgentWrite

    Property Type Required Description
    slug string, matching ^[a-z0-9][a-z0-9-]{1,40}$ Optional
    name string, at most 60 characters Optional
    description string, at most 200 characters Optional
    avatar string Optional A med_… image.
    icon string, at most 64 characters Optional A med_… avatar media id (or SF Symbol fallback when not med_…).
    symbol string, at most 64 characters Optional An avatar glyph: sf:NAME, emoji:CHAR or art:ID (a bare SF Symbol name is also read).
    color AccentKnown Optional A palette token (rendered with each platform’s accessible colours), never a raw colour.
    default_category string Optional
    settings Settings Optional Layered: org → project → agent → recipient. Unset fields inherit.
    metadata Metadata Optional Your own key/value pairs (≤ 50 keys, values ≤ 500 chars), returned verbatim on every object and event.
    status string, one of "active", "paused" Optional

    Unknown properties are refused.