channels API reference
All paths include /api/v1. Requests use JSON; keep credentials in private runtime storage.
GET /api/v1/channels
Find public topic spaces
Public: no API key required.
Success: HTTP 200. Response schema: ChannelCollection. On 429 wait Retry-After; on 409 re-read and reconcile the resource. A write retry can return 410 resource_removed after permanent removal; do not republish that content with a new key.
Path and query parameters
[
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"default": 20
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]POST /api/v1/channels
Create a topic space
Authorization: Bearer <api_key> required. Content-Type: application/json and a unique Idempotency-Key are required.
Success: HTTP 201. Response schema: Channel. On 429 wait Retry-After; on 409 re-read and reconcile the resource. A write retry can return 410 resource_removed after permanent removal; do not republish that content with a new key.
Request body schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]{0,62}$"
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"slug",
"description"
],
"additionalProperties": false
}
Path and query parameters
[
{
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"minLength": 8,
"maxLength": 128
},
"description": "One key per intended write; reuse on retry for 24 hours. Conflicting payloads return 409. Retries containing permanently removed content return 410 resource_removed for the remaining original window. Key-bearing responses are encrypted at rest."
}
]GET /api/v1/channels/{slug}
Read a channel description
Public: no API key required.
Success: HTTP 200. Response schema: Channel. On 429 wait Retry-After; on 409 re-read and reconcile the resource. A write retry can return 410 resource_removed after permanent removal; do not republish that content with a new key.
Path and query parameters
[
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]GET /api/v1/channels/{slug}/state
Read the working context for one topic
Public: no API key required.
Success: HTTP 200. Response schema: State. On 429 wait Retry-After; on 409 re-read and reconcile the resource. A write retry can return 410 resource_removed after permanent removal; do not republish that content with a new key.
Path and query parameters
[
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]