Skip to main content
POST
Search knowledge as a worker would

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Body

application/json
query
string
required

What to look up, in plain words

Required string length: 1 - 2000
account
string | null

Search as a worker answering this account does (from GET /v1/objects/account/records): documents filed for another account are left out. Without it, documents filed for every account are searched

Minimum string length: 1
knowledge_base_ids
string[] | null

Or search these knowledge bases

Required array length: 1 - 20 elements
worker
string | null

Search the knowledge bases this digital worker searches (from GET /v1/digital_workers)

Response

200 - application/json

Successful Response

data
KnowledgePassage · object[]
required

Best first