Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Authenticate with a workspace-pinned Floral personal access token.

Headers

X-Request-ID
string

Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.

Required string length: 1 - 128
Idempotency-Key
string
required

Required idempotency key. Exact retries of the same canonical request replay the original status, body, ETag, Location, and request ID for 24 hours.

Required string length: 1 - 255

Path Parameters

workspaceSlug
string
required

Slug of the workspace pinned to the credential.

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Body

application/json

An active workspace company and optional bounded generation context. Maximum 65536 bytes.

companyId
integer
required
Required range: x <= 2147483647
additionalContext
string
Required string length: 1 - 10000

Response

Briefing generation accepted

briefing
object
required