Skip to main content
POST
Generate Use Cases

Authorizations

api_key
string
header
required

Body

application/json

Use case generation input with source materials

useCases
object[]
required

Array of use case generation requests - each object generates one use case

Minimum array length: 1
Example:
primaryOfferingOId
string

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

Example:

"o_123456"

brandVoiceOId
string

Brand voice oId to apply to generated use cases

Example:

"bv_123456"

linkingStrategy
object

Strategy for linking generated use cases to offerings (products/services)

Response

Use cases generated successfully

_metadata
object
required
data
object[]
required