Create an AI recipe board

Creates a new AI-generated board using natural language instructions. Returns an AI recipe board creation status URL object that you can poll to check creation progress.

📘

API key

You will need to include your API key found here.

Please include the key in your header. {"X-API-KEY": <api_key>}
🤖 Asynchronous Processing

AI recipe board creation is asynchronous. You'll receive a status URL immediately and need to poll it until the board is ready.

{
  "data": {
    "type": "ai_recipe_board",
    "attributes": {
      "boardCreationInstructions": "Create a vocabulary board for 5th grade science terms about the solar system",
      "role": "teacher",
      "workspaceId": "abcd1234efgh5678"
    }
  }
}

Body parameters

* required

PropertiesTypeDescription
type*stringType should be set to ai_recipe_board.
attributes.boardCreationInstructions*stringNatural language instructions for board creation. Maximum 2000 characters.

Be specific about the target audience, subject matter, and desired content type for best results.
attributes.role*stringThe role or context for board creation. This field is required.
attributes.workspaceIdstringWorkspace ID to create the board within a workspace context.

Requires admin or owner permissions for the specified workspace.
Language
Credentials
Header
Click Try It! to start a request and see the response here!