Plan block

Fields

Field	Type	Description	Required?
type	String	The type of block. For this block, type will always be plan.	Required
title	Object	Title of the plan in plain text	Required
block_id	String	A unique identifier for a block. If not specified, one will be generated. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.	Optional
tasks	Array	A sequence of task card blocks. Each task represents a single action within the plan.	Optional

Usage info

Examples

JSON

{
  "blocks": [
    {
      "type": "plan",
      "title": "Thinking completed",
      "tasks": [
        {
          "task_id": "call_001",
          "title": "Fetched user profile information",
          "status": "in_progress",
          "details": {
            "type": "rich_text",
            "block_id": "viMWO",
            "elements": [
              {
                "type": "rich_text_section",
                "elements": [
                  {
                    "type": "text",
                    "text": "Searched database..."
                  }
                ]
              }
            ]
          },
          "output": {
            "type": "rich_text",
            "block_id": "viMWO",
            "elements": [
              {
                "type": "rich_text_section",
                "elements": [
                  {
                    "type": "text",
                    "text": "Profile data loaded"
                  }
                ]
              }
            ]
          }
        },
        {
          "task_id": "call_002",
          "title": "Checked user permissions",
          "status": "pending",
        },
        {
          "task_id": "call_003",
          "title": "Generated comprehensive user report",
          "status": "complete",
          "output": {
            "type": "rich_text",
            "block_id": "crsk",
            "elements": [
              {
                "type": "rich_text_section",
                "elements": [
                  {
                    "type": "text",
                    "text": "15 data points compiled"
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ]
}