Copilot

Chat With Copilot

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.

post/copilot/chat

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/copilot/chat
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

messagestring required
mentionsobject[] nullable

Results from POST /copilot/mention-search.

session_idstring nullable
web_searchboolean

Search the web before answering.

thinkingboolean

Extended thinking.

researchboolean

Multi-step deep research. The most expensive option.

Response

Successful Response

dataStudioContentPayload required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.