Create or find board

Returns the existing board if one exists, else provisions it from the domain template. Requires boards:write.

Request

curl -X POST "https://api.blueticks.co/v1/boards" \  -H "Content-Type: application/json" \  -d '{    "domain": "tasks",    "agent_id": "btgpt:USER_ID"  }'

{
  "success": true,
  "data": {
    "board_id": "string",
    "name": "string",
    "domain": "string",
    "agent_managed": true,
    "memory_retention_days": 0,
    "item_count": 0,
    "web_url": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "columns": [
      {
        "column_id": "string",
        "title": "string",
        "type": "string",
        "options": [
          {
            "label": "string",
            "bgcolor": "string"
          }
        ]
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "requestId": "string",
    "details": [
      {
        "path": "string",
        "code": "string",
        "message": "string"
      }
    ]
  }
}

Request Body

application/json

domain?string

Memory domain id for a built-in board — tasks, leads or invoices. Omit and pass entity_kind to open a board for a NEW entity type.

Length1 <= length

entity_kind?string

The kind of entity this board tracks (e.g. reminders, orders, follow-ups). Opens a NEW dynamic board with a generic Status/Priority/Date/Source template. Slug-ified server-side; a custom:<slug> domain is derived unless the slug already names a built-in domain. description is REQUIRED for custom boards.

Length1 <= length <= 40

name?string

Board name; defaults to the domain label (custom: 🤖 <entity_kind>).

Length1 <= length <= 120

description?string

One-line purpose of the board (subtitle + board directory). Optional for built-in domains (falls back to the domain default); REQUIRED for custom entity_kind boards (422 if missing).

Length1 <= length <= 500

agent_id?string

Owning agent id for memory isolation (e.g. btgpt:<userId> or bot:<botId>). Defaults to user.

Lengthlength <= 200

memory_retention_days?integer

Retention window in days (default 30; 0 = never expires).

Range0 <= value <= 3650

Create or find board

Request

Request Body

Response

Response Body

`application/json`

`application/json`

Create or find board

Request

Request Body

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`