AI Recipe Board Status objects represent the status and result of AI-generated board creation requests.

📘
Asynchronous Process
AI Recipe Board creation is asynchronous. You'll receive a status URL immediately and need to poll it until the board is ready.

AI Recipe Board Status Object

Returned when polling the status URL. The structure varies based on the current status:

In Progress Status

{
  "data": {
    "id": "572e81c693",
    "type": "aiRecipeBoardStatus",
    "attributes": {
      "status": "in_progress"
    }
  }
}

Success Status (with Board)

{
  "data": {
    "id": "63ced8f6bd",
    "type": "aiRecipeBoardStatus",
    "attributes": {
      "status": "success",
      "board": {
        "id": "uu5qs3r2z3htk7k4",
        "type": "board",
        "attributes": {
          "title": "Alphabet Adventure for First Graders!",
          "description": "Let's explore each letter of the alphabet with fun images and words!",
          "builder": {
            "username": "mcfrogman",
            "shortName": "mcfrogman",
            "fullName": "",
            "avatarUrl": "https://padlet.net/monsters/4.png"
          },
          "domainName": "padlet.dev",
          "iconUrl": "",
          "webUrl": {
            "live": "https://padlet.com/organizationexampleid/alphabet-adventure-uu5qs3r2z3htk7k4",
            "qrCode": "https://cdn.padlet.com/padlets/id/qr_code.png",
            "slideshow": "https://padlet.com/organizationexampleid/alphabet-adventure-uu5qs3r2z3htk7k4/slideshow",
            "slideshowQrCode": "https://cdn.padlet.com/padlets/id/slideshow_qr_code.png"
          },
          "settings": {
            "font": 1,
            "colorScheme": "light"
          },
          "createdAt": "2025-06-19T00:46:52Z",
          "updatedAt": "2025-06-19T00:46:57Z"
        },
        "relationships": {}
      }
    }
  }
}

Failed Status

{
  "data": {
    "id": "abc123def456",
    "type": "aiRecipeBoardStatus",
    "attributes": {
      "status": "failed"
    }
  }
}

AI Recipe Board Status Object Properties

Properties	Type	Description
`id`	`string`	Unique identifier for this status response
`type`	`string`	Always `"aiRecipeBoardStatus"`.
`attributes.status`	`string`	Current status: `"in_progress"`, `"success"`, or `"failed"`
`attributes.board`	`object`	Optional. The created board object. Only present when `status` is `"success"`.

Status Values

Status	Description	Board Included
`in_progress`	The AI is currently generating your board	No
`success`	Board creation completed successfully	Yes
`failed`	Board creation failed due to an error	No