Skip to content

Load Copilot Intent Context

POST
/copilot/context/load

Open a Copilot session already briefed on one buyer-intent keyword.

Returns session_id. The session is seeded with the keyword’s detail (and the company or contact, if given), so the first question can be about it without restating it. No model runs here.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of load_intent_context.router.LoadIntentContextRequest.

object
company_id
Any of:
integer
contact_id
Any of:
integer
keyword_id
required

The buyer-intent keyword to open a conversation about.

string format: uuid

Responses

201

Successful Response

object
data
required

An open envelope for the app’s answer.

Open because the chat answer (kind, message, chips, sources, work_item_id, …) and the oversight feed (approvals, blockers, autonomous_fixes, states, bounds) are both still growing, and a dropped field on an agent surface is one the caller does not know they lost.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string