Skip to main content
POST
/
v1
/
knowledge
/
ask
Ask
curl --request POST \
  --url https://api.adapter.com/v1/knowledge/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "timezone": "America/New_York",
  "metadata": {
    "env": "staging"
  }
}
'
{
  "citations": [
    {
      "entity": {},
      "type": "<string>"
    }
  ],
  "response": "<string>",
  "truncated": true
}

Authorizations

​
Authorization
string
header
required

Pass your pk_live_... API key as a Bearer token.

Body

application/json
​
query
string
required
Required string length: 1 - 2000
Example:

"What are our top blockers for Q1?"

​
timezone
string | null

IANA timezone identifier (e.g. "America/New_York") for resolving relative time references like "today" or "last week". Defaults to UTC.

Example:

"America/New_York"

​
metadata
Metadata · object

Restrict the evidence the model can ground its answer in to rows whose metadata contains ALL the given key/value pairs (AND-of-exact-match). Max 20 keys; string values only.

Example:
{ "env": "staging" }

Response

Successful Response

​
citations
Citation · object[]
required

Per-record citations grounding the output.

​
response
string
required

Output generated for your query.

​
truncated
boolean
required

True when citations was capped — your answer drew on more supporting records than are returned. The omitted records are similar in shape to the ones present; refine your query if you need them enumerated.