askBidDesk
Requires permission biddesk:assembly:read.
Answers a question about an item or assembly in up to six sentences, each citing its sources, using only what the caller may read: published knowledge notes, the released structure, items and their vendors' lead times, the bids that used it and their debriefs and teams, imported past bids, and the clause library. NO_ANSWER ("I don't know") when nothing answers it; UNAVAILABLE with a code when the answer could not be produced (Bid Desk AI plan feature off, budget, or an answer that failed its check). An amount appears only when a cited source holds it. Changes no data. Requires Bid Desk with engineered products and permission to read assemblies; bids and imported history count only with permission to read bids, past costs only with cost visibility.
Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.
Example:
- GraphQL
- cURL
mutation AskBidDesk($input: AskBidDeskInput!) {
askBidDesk(input: $input) {
code
status
askedAt
question
runId
citations {
type
index
label
path
refId
}
}
}
curl -X POST "https://<api-host>/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data @- <<'EOF'
{
"query": "mutation AskBidDesk($input: AskBidDeskInput!) {\n askBidDesk(input: $input) {\n code\n status\n askedAt\n question\n runId\n citations {\n type\n index\n label\n path\n refId\n }\n }\n}",
"variables": {
"input": {
"productId": "id",
"question": "string"
}
}
}
EOF
Variables:
{
"input": {
"productId": "id",
"question": "string"
}
}
Response:
{
"data": {
"askBidDesk": {
"code": "string",
"status": "ANSWERED",
"askedAt": "2025-01-15T00:00:00Z",
"question": "string",
"runId": "id",
"citations": [
{
"type": "ASSEMBLY",
"index": 0,
"label": "string",
"path": "string",
"refId": "id"
}
]
}
}
}
askBidDesk(
input: AskBidDeskInput!
): BidDeskAnswer!
Arguments
askBidDesk.input ● AskBidDeskInput! non-null input
The item or assembly and the question.
Type
BidDeskAnswer object
An answer drawn only from records the asker may read, each sentence cited, or a plain "I don't know".