Skip to main content
POST
Create Collection Request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand

Body

application/json

Request to trigger on-demand collection for a prompt across specified platforms.

prompt_id
integer
required

The ID of the prompt to collect

platforms
enum<string>[]
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
  • grok - xAI Grok
Minimum array length: 1
Available options:
chatgpt,
claude,
google_ai_overviews,
perplexity,
meta,
google_ai_mode,
google_gemini,
copilot,
grok

Response

Successful Response

Response from triggering on-demand collection.

prompt_id
integer
required

The prompt ID that collection was triggered for

events
CollectionEventResult · object[]
required

List of triggered collection events, one per platform