Skip to main content
POST
Generate References

Authorizations

api_key
string
header
required

Body

application/json

Reference generation input with source materials

references
object[]
required

Array of reference generation requests - each object generates one reference

Minimum array length: 1
Example:
primaryOfferingOId
string

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

Example:

"o_123456"

linkingStrategy
object

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

brandVoiceOId
string

Brand voice oId to apply to generated references

Example:

"bv_123456"

Response

References generated successfully

_metadata
object
required
data
object[]
required