orgAiSuggestions

Requires permission biddesk:bid:read.

Lists one organisation-level AI skill's suggestions, oldest first, at most 200; optionally from one set-up file, about one record, or in one state. Requires Bid Desk, permission to read bids and the permission the skill names for reading its suggestions.

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

query OrgAiSuggestions($skillKey: String!) {
  orgAiSuggestions(skillKey: $skillKey) {
    id
    status
    createdAt
    appliedRefId
    appliedRefType
    citations
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query OrgAiSuggestions($skillKey: String!) {\n  orgAiSuggestions(skillKey: $skillKey) {\n    id\n    status\n    createdAt\n    appliedRefId\n    appliedRefType\n    citations\n  }\n}",
  "variables": {
    "skillKey": "string"
  }
}
EOF

Variables:

{
  "skillKey": "string"
}

Response:

{
  "data": {
    "orgAiSuggestions": [
      {
        "id": "id",
        "status": "ACCEPTED",
        "createdAt": "2025-01-15T00:00:00Z",
        "appliedRefId": "id",
        "appliedRefType": "string",
        "citations": {}
      }
    ]
  }
}

orgAiSuggestions(
  skillKey: String!
  sourceId: ID
  status: BidAiSuggestionStatus
  subjectId: ID
  take: Int
): [BidAiOrgSuggestion!]!

Arguments

orgAiSuggestions.skillKey ● String! non-null scalar

The skill.

orgAiSuggestions.sourceId ● ID scalar

Only suggestions read from this set-up file.

orgAiSuggestions.status ● BidAiSuggestionStatus enum

Only suggestions in this state.

orgAiSuggestions.subjectId ● ID scalar

Only suggestions about this record.

orgAiSuggestions.take ● Int scalar

At most this many, up to 200.

Type

BidAiOrgSuggestion object

A change a Bid Desk AI run suggests for the organisation rather than a bid (an onboarding import, an induced model). Nothing is written until a person accepts it.