Skip to content

Chat With Copilot

POST
/copilot/chat

Ask the Studio copilot. SPENDS CREDIT - a model runs, and may call tools.

Returns response (the full answer) and events (every text, tool and source event, in order). web_search, thinking and research each add work and cost; research the most. Tools that need a person’s approval are proposed in events, not executed. 402 when the org is out of credit.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

One message to the Studio copilot. SPENDS CREDIT. The answer is returned whole.

object
canvas_context
Any of:

What the copilot is looking at: a document, a selection, a campaign or account.

object
accountId
Any of:
string
activeDocument
Any of:
object
key
additional properties
any
campaignId
Any of:
string
cursor
Any of:
object
key
additional properties
integer
mode
string
default: global
Allowed values: global campaign account
selection
Any of:
object
key
additional properties
any
conversation_history
Any of:
Array<object>

One earlier turn of the conversation.

object
content
required
string
role
required
string
Allowed values: user assistant system tool
tool_name
Any of:
string
tool_result
Any of:
object
key
additional properties
any
mentions
Any of:
Array<object>
object
key
additional properties
any
message
required
string
>= 1 characters
research

Multi-step deep research. The most expensive option.

boolean
session_id
Any of:
string
thinking

Extended thinking.

boolean
web_search

Search the web before answering.

boolean

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

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