POST
/
beta
/
cards
/
search
Search cards using semantic search
curl --request POST \
  --url https://api.vistaly.com/beta/cards/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter": {
    "must": [
      {
        "key": "archived",
        "match": {
          "value": true
        }
      }
    ],
    "must_not": [
      {
        "key": "archived",
        "match": {
          "value": true
        }
      }
    ],
    "should": [
      {
        "key": "archived",
        "match": {
          "value": true
        }
      }
    ]
  },
  "query": "<string>"
}'
{
  "message": "Cards searched"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
filter
object

Used to apply filters based on a card's metadata

query
string

Natural language search query that finds cards with similar content. The query is converted to a vector representation and matches cards based on semantic similarity to card titles and details. Use filters for exact matches on card metadata (status, type, dates, etc.).

Response

Metrics submitted successfully

message
string
Example:

"System provided message"