Desk

Ask Desk

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.

post/desk/ask

Request

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

questionstring required
decision_idstring uuid nullable

Ground the answer in this decision card.

deal_idstring nullable

Ground the answer in this deal.

Response

Successful Response

dataDeskPayload 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.

Changes

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