Search Dataset

Search a dataset for records matching a given search query

post

/v1/dataset/{datasetId}/search

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

datasetIdstring* Required

The ID of the dataset to search

Request Body * Required

Request Body Schema: application/json

searchstring

The keyword/phrase to search for

filterobject


curl -X POST "https://api.chatbotkit.com/v1/dataset/{datasetId}/search" \
-H "Authorization: Bearer $CHATBOTKIT_API_SECRET" \
-H "Content-Type: application/json" \
--data-binary @- << EOF
{"search":"string",
"filter":"object"
}
EOF

{"id":"string",
"records":[{"id":"string",
"text":"string"
}
]
}

The search was successful