---
title: "Ask Desk"
method: POST
path: "/desk/ask"
tags: ["Desk"]
---

# Ask Desk

`POST /desk/ask`

## Request

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

Ask a grounded question about a card or a deal.

FAIL-SOFT: with the org's `ai_briefs` switch off it returns a canned answer
and HTTP 200, not an error. A caller that needs to know whether it got a
real answer should look at the payload, not the status code.

## Headers

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

## Request body

- DeskAskRequest: A grounded question about a card or a deal. Give it something to ground on: with neither `decision_id` nor `deal_id` the answer has no record to read and comes back generic.
  - `question` string, required
  - `decision_id` string, uuid, nullable: Ground the answer in this decision card.
  - `deal_id` string, nullable: Ground the answer in this deal.

## Response `200`

Successful Response

- ApiResponseDeskPayload
  - `data` DeskPayload, required: An open envelope for one desk object. Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.
  - `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/89fc11143b70?raw)