Creates a new AI-generated board using natural language instructions
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 keyYou will need to include your API key found here.
Please include the key in your header.
{"X-API-KEY": <api_key>}
🤖 Asynchronous ProcessingAI 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
| Properties | Type | Description |
|---|---|---|
type* | string | Type should be set to ai_recipe_board. |
attributes.boardCreationInstructions* | string | Natural 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* | string | The role or context for board creation. This field is required. |
attributes.workspaceId | string | Workspace ID to create the board within a workspace context. Requires admin or owner permissions for the specified workspace. |