Skip to content

Ask Desk

POST
/desk/ask

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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
deal_id
Any of:
string
<= 255 characters
decision_id
Any of:
string format: uuid
question
required
string
>= 1 characters <= 2000 characters

Responses

200

Successful Response

object
data
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.

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