---
title: "Chat With Copilot"
method: POST
path: "/copilot/chat"
tags: ["Copilot"]
---

# Chat With Copilot

`POST /copilot/chat`

## Request

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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- CopilotChatRequest: One message to the Studio copilot. SPENDS CREDIT. The answer is returned whole.
  - `message` string, required
  - `canvas_context` CopilotCanvasContext: What the copilot is looking at: a document, a selection, a campaign or account.
    - `activeDocument` object, nullable: {path, content, type, status}.
    - `selection` object, nullable: {text, start_line, end_line}.
    - `cursor` object, nullable: {line, column}.
    - `mode` 'global' | 'campaign' | 'account'
    - `campaignId` string, nullable
    - `accountId` string, nullable
  - `conversation_history` CopilotChatMessage[], nullable
    - `role` 'user' | 'assistant' | 'system' | 'tool', required
    - `content` string, required
    - `tool_name` string, nullable
    - `tool_result` object, nullable
  - `mentions` object[], nullable: Results from `POST /copilot/mention-search`.
  - `session_id` string, nullable
  - `web_search` boolean: Search the web before answering.
  - `thinking` boolean: Extended thinking.
  - `research` boolean: Multi-step deep research. The most expensive option.

## Response `200`

Successful Response

- ApiResponseStudioContentPayload
  - `data` StudioContentPayload, required: One Studio object, open-shaped. See the module docstring.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)