Skip to main content
POST
Generate Competitors

Authorizations

api_key
string
header
required

Body

application/json

Competitor generation input with source materials

competitors
object[]
required

Array of competitor generation requests - each object generates one competitor analysis

Minimum array length: 1
Example:
primaryOfferingOId
string

Primary Offering to use as context when generating competitors. If not provided, the primary company attached to the Workspace will be used.

Example:

"o_123456"

linkingStrategy
object

Strategy for linking generated competitors to offerings (products/services)

brandVoiceOId
string

Brand voice oId to apply to generated competitors

Example:

"bv_123456"

Response

Competitors generated successfully

_metadata
object
required
data
object[]
required