BrightEdge Technologies ai_catalyst API
APIs for ai_catalyst dataset
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/brightedge-technologies-ai-catalyst-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: BrightEdge Platform AI Catalyst API
description: This API provides the ability to integrate with BrightEdge Platform
version: 5.0.0
tags:
- name: ai_catalyst
description: APIs for ai_catalyst dataset
paths:
/5.0/objects/aicatalyst/accounts:
get:
tags:
- ai_catalyst
summary: This call returns the list of accounts where ai catalyst is enabled
operationId: get_all_accounts_5_0_objects_aicatalyst_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AICatalystsAccountOut'
type: array
title: Response Get All Accounts 5 0 Objects Aicatalyst Accounts Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/get_all_collectors:
get:
tags:
- ai_catalyst
summary: This call returns the list of all collectors supported by ai catalyst
operationId: get_all_collectors_5_0_objects_aicatalyst_get_all_collectors_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledCollectors'
/5.0/objects/aicatalyst/prompts/{account_id}:
get:
tags:
- ai_catalyst
summary: List of prompts set up in the account
operationId: get_prompts_list_5_0_objects_aicatalyst_prompts__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPromptsListOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/prompt_info/{account_id}/{prompt_id}:
get:
tags:
- ai_catalyst
summary: Detailed info about one prompt
operationId: get_prompts_list_5_0_objects_aicatalyst_prompt_info__account_id___prompt_id__get
parameters:
- required: true
schema:
type: integer
title: Prompt Id
name: prompt_id
in: path
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptInfo'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/promptgroups/{account_id}:
get:
tags:
- ai_catalyst
summary: List of prompt groups set up in the account
operationId: get_prompts_list_5_0_objects_aicatalyst_promptgroups__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptGroupOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/promptgroups/prompts/{account_id}/{prompt_group_id}:
get:
tags:
- ai_catalyst
summary: 'List of prompts tied to the specified prompt group '
operationId: get_prompt_group_and_prompt_name_5_0_objects_aicatalyst_promptgroups_prompts__account_id___prompt_group_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
type: integer
title: Prompt Group Id
name: prompt_group_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptGroupPromptsOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/aiengines/{account_id}:
get:
tags:
- ai_catalyst
summary: View all enabled AI engines for the account
operationId: get_prompt_group_and_prompt_name_5_0_objects_aicatalyst_aiengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledEngines'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/enabled_collectors/{account_id}:
get:
tags:
- ai_catalyst
summary: View all enabled collectors for the account
operationId: get_enabled_collectors_5_0_objects_aicatalyst_enabled_collectors__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledCollectorsForAccount'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/list_brand_categories:
post:
tags:
- ai_catalyst
summary: Get list of brand categories with filtering and sorting support
operationId: list_brand_category_5_0_objects_aicatalyst_list_brand_categories_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystBrandCategoryRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPresenceBrandCategory'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/query:
post:
tags:
- ai_catalyst
summary: Get the share of citations or mentions data (legacy format)
operationId: share_of_data_5_0_objects_aicatalyst_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/v2/query:
post:
tags:
- ai_catalyst
summary: Get the share of citations, mentions, or prompts data with dimensions and measures
operationId: share_of_data_v2_5_0_objects_aicatalyst_v2_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataRequestV2'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataResponseV2'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/aicatalyst/personas/{account_id}:
get:
tags:
- ai_catalyst
summary: View all personas for the account
operationId: get_personas_5_0_objects_aicatalyst_personas__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPersonas'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/accounts:
get:
tags:
- ai_catalyst
summary: This call returns the list of accounts where ai catalyst is enabled
operationId: get_all_accounts_latest5_objects_aicatalyst_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AICatalystsAccountOut'
type: array
title: Response Get All Accounts Latest5 Objects Aicatalyst Accounts Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/get_all_collectors:
get:
tags:
- ai_catalyst
summary: This call returns the list of all collectors supported by ai catalyst
operationId: get_all_collectors_latest5_objects_aicatalyst_get_all_collectors_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledCollectors'
/latest5/objects/aicatalyst/prompts/{account_id}:
get:
tags:
- ai_catalyst
summary: List of prompts set up in the account
operationId: get_prompts_list_latest5_objects_aicatalyst_prompts__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPromptsListOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/prompt_info/{account_id}/{prompt_id}:
get:
tags:
- ai_catalyst
summary: Detailed info about one prompt
operationId: get_prompts_list_latest5_objects_aicatalyst_prompt_info__account_id___prompt_id__get
parameters:
- required: true
schema:
type: integer
title: Prompt Id
name: prompt_id
in: path
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptInfo'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/promptgroups/{account_id}:
get:
tags:
- ai_catalyst
summary: List of prompt groups set up in the account
operationId: get_prompts_list_latest5_objects_aicatalyst_promptgroups__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptGroupOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/promptgroups/prompts/{account_id}/{prompt_group_id}:
get:
tags:
- ai_catalyst
summary: 'List of prompts tied to the specified prompt group '
operationId: get_prompt_group_and_prompt_name_latest5_objects_aicatalyst_promptgroups_prompts__account_id___prompt_group_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
type: integer
title: Prompt Group Id
name: prompt_group_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsPromptGroupPromptsOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/aiengines/{account_id}:
get:
tags:
- ai_catalyst
summary: View all enabled AI engines for the account
operationId: get_prompt_group_and_prompt_name_latest5_objects_aicatalyst_aiengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledEngines'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/enabled_collectors/{account_id}:
get:
tags:
- ai_catalyst
summary: View all enabled collectors for the account
operationId: get_enabled_collectors_latest5_objects_aicatalyst_enabled_collectors__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystEnabledCollectorsForAccount'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/list_brand_categories:
post:
tags:
- ai_catalyst
summary: Get list of brand categories with filtering and sorting support
operationId: list_brand_category_latest5_objects_aicatalyst_list_brand_categories_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystBrandCategoryRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPresenceBrandCategory'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/query:
post:
tags:
- ai_catalyst
summary: Get the share of citations or mentions data (legacy format)
operationId: share_of_data_latest5_objects_aicatalyst_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/v2/query:
post:
tags:
- ai_catalyst
summary: Get the share of citations, mentions, or prompts data with dimensions and measures
operationId: share_of_data_v2_latest5_objects_aicatalyst_v2_query_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataRequestV2'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystsShareOfDataResponseV2'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/aicatalyst/personas/{account_id}:
get:
tags:
- ai_catalyst
summary: View all personas for the account
operationId: get_personas_latest5_objects_aicatalyst_personas__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 10000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AICatalystPersonas'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
components:
schemas:
AICatalystPersonas:
properties:
success:
type: boolean
title: Success
message:
type: string
title: Message
personas:
items:
$ref: '#/components/schemas/AICatalystPersona'
type: array
title: Personas
type: object
required:
- success
- message
- personas
title: AICatalystPersonas
OutputType:
type: string
enum:
- parsed
- raw
- summary_only
title: OutputType
description: Output type for data requests
AIBDatasetType:
type: string
enum:
- mentions
- citations
- prompts
title: AIBDatasetType
description: Dataset type for AI Brand Presence data requests
AICatalystsPromptGroupPromptsOut:
properties:
account_id:
type: integer
title: Account Id
success:
type: boolean
title: Success
message:
type: string
title: Message
prompt_groups:
items:
$ref: '#/components/schemas/AICatalystsPromptGroupPrompts'
type: array
title: Prompt Groups
type: object
required:
- account_id
- success
- message
- prompt_groups
title: AICatalystsPromptGroupPromptsOut
AICatalystPromptsListOut:
properties:
account_id:
type: integer
title: Account Id
success:
type: boolean
title: Success
message:
type: string
title: Message
prompt_groups:
items:
$ref: '#/components/schemas/AICatalystPromptsList'
type: array
title: Prompt Groups
type: object
required:
- account_id
- success
- message
- prompt_groups
title: AICatalystPromptsListOut
AICatalystEnabledCollectorsForAccount:
properties:
success:
type: boolean
title: Success
message:
type: string
title: Message
account_id:
type: integer
title: Account Id
collectors:
items:
$ref: '#/components/schemas/CollectorInfo'
type: array
title: Collectors
type: object
required:
- success
- message
- account_id
- collectors
title: AICatalystEnabledCollectorsForAccount
AICatalystPersona:
properties:
persona_id:
type: integer
title: Persona Id
name:
type: string
title: Name
description:
type: string
title: Description
updated_by:
$ref: '#/components/schemas/AIBUser'
created_at:
type: string
format: date-time
title: Created At
is_default:
type: boolean
title: Is Default
date_updated:
type: string
format: date-time
title: Date Updated
type: object
required:
- persona_id
- name
- description
title: AICatalystPersona
AICatalystsPromptInfo:
properties:
prompt_id:
type: integer
title: Prompt Id
prompt_name:
type: string
title: Prompt Name
intents:
type: string
title: Intents
prompt_groups:
type: string
title: Prompt Groups
collector_ids:
items:
type: integer
type: array
title: Collector Ids
country:
type: string
title: Country
created_on:
type: string
format: date-time
title: Created On
last_updated_on:
type: string
format: date-time
title: Last Updated On
type: object
required:
- prompt_id
- prompt_name
- created_on
- last_updated_on
title: AICatalystsPromptInfo
AICatalystPromptsList:
properties:
prompt_id:
type: integer
title: Prompt Id
prompt_name:
type: string
title: Prompt Name
collector_ids:
items:
type: integer
type: array
title: Collector Ids
intent:
items:
type: string
type: array
title: Intent
type: object
required:
- prompt_id
- prompt_name
- collector_ids
- intent
title: AICatalystPromptsList
AIBUser:
properties:
user_id:
type: integer
title: User Id
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
email:
type: string
title: Email
type: object
required:
- user_id
- first_name
- last_name
- email
title: AIBUser
AICatalystEnabledCollectors:
properties:
success:
type: boolean
title: Success
message:
type: string
title: Message
collectors:
items:
$ref: '#/components/schemas/CollectorInfo'
type: array
title: Collectors
type: object
required:
- success
- message
- collectors
title: AICatalystEnabledCollectors
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Er
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brightedge-technologies/refs/heads/main/openapi/brightedge-technologies-ai-catalyst-api-openapi.yml