Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Body

application/json
message
string
required

Plain-language instruction for the copilot.

threadId
string

Continue an existing copilot conversation (from listAssistThreads). Omit to start a new thread.

context
object

Optional free-form hints the client attaches to the turn (e.g. the screen the user is on). Any JSON object; keys are advisory and passed through to the copilot.

confirmed
object[]

Previously returned pendingConfirmations entries the user approved, re-sent verbatim to actually run those held destructive actions.

Response

SSE stream; terminal frame carries AssistResult.

reply
string
threadId
string

The thread this turn belongs to (persistent memory).

appliedMutations
object[]
pendingConfirmations
object[]

Destructive tool calls the copilot wants to run, held until the user confirms (re-send as confirmed).

connects
object[]

OAuth connect affordances the client renders as a button (never the raw consent URL in the reply prose).