Create Collection Request

Triggers on-demand collection for a prompt across the specified AI platforms. Each platform will be queried and the response evaluated independently.

Requires the configure scope. The prompt must be active and have active variants for the requested platforms; paused or archived prompts cannot be collected.

post/{brand_id}/collections

Path parameters

brand_idinteger required

The unique identifier for the brand

The unique identifier for the brand

Request body

prompt_idinteger required

The ID of the prompt to collect

platformsstring[] required

AI platforms to trigger collection on.

Supported platforms:

  • chatgpt - OpenAI ChatGPT
  • claude - Anthropic Claude
  • google_ai_overviews - Google AI Overviews (Search)
  • perplexity - Perplexity AI
  • meta - Meta AI
  • google_ai_mode - Google AI Mode
  • google_gemini - Google Gemini
  • copilot - Microsoft Copilot

Response

Successful Response

prompt_idinteger required

The prompt ID that collection was triggered for

Changes

No recorded changes to this endpoint across all 11 revisions of this API.