Skip to main content
POST
/
ideaclouds
/
batch
Create IdeaClouds in batch
curl --request POST \
  --url https://api.app.hrizn.io/v1/public/ideaclouds/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "items": [
    {
      "keyword": "<string>",
      "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "data": {
    "items": [
      {
        "id": "0b3252dd-d82c-4dab-9656-c6095163bb30",
        "keyword": "best SUVs for families 2026",
        "status": "researching"
      },
      {
        "id": "edc2bcc6-88d5-46d2-94cb-009236562b7e",
        "keyword": "Chevrolet Silverado towing capacity guide",
        "status": "researching"
      }
    ],
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
Submit multiple keywords for research in one request. Each item is processed independently. Scope required: ideaclouds:write

Request body

items
array
required
Array of IdeaCloud creation objects (max 25).

Response

Returns 202 Accepted with status for each item.
{
  "data": {
    "items": [
      {
        "id": "0b3252dd-d82c-4dab-9656-c6095163bb30",
        "keyword": "best SUVs for families 2026",
        "status": "researching"
      },
      {
        "id": "edc2bcc6-88d5-46d2-94cb-009236562b7e",
        "keyword": "Chevrolet Silverado towing capacity guide",
        "status": "researching"
      }
    ],
    "message": "Generation typically completes within a few minutes. Configure webhooks to receive real-time status notifications: https://api-docs.hrizn.io/webhooks"
  }
}
IdeaCloud research is asynchronous and typically completes within a few minutes. Configure webhooks to receive real-time ideacloud.completed and ideacloud.failed notifications instead of polling.

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Body

application/json
items
object[]
required
Required array length: 1 - 25 elements

Response

Batch accepted

data
object
Last modified on March 1, 2026