Search
Retrieve stories by meaning through a natural-language query.
Request
- Base URLhttps://api.storyblok.com
- AuthAPI key in query parameter token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The search term. Write it as a natural-language question or phrase.
The content version to retrieve: draft or published. Default is published. Retrieving draft requires a preview access token.
The maximum number of results to return. Default is 25. Maximum is 100, or 50 when starts_with or content_type is set.
Filter by the story’s full_slug to return items starting with the given value. Matches only the default-language slug, so language prefixes (for example, de/) and translated slugs return no results.
Retrieve stories of a specific content type block. For example, content_type=page.
A preview or public access token configured in a space.
Response
Search results
Example response
{
"results": [
{
"excerpt": "You can return any item within 30 days...",
"score": 0.89,
"story": {
"id": 1001,
"slug": "pricing/returns",
"name": "Returns"
}
},
{
"excerpt": "Refunds are processed within 5 business days...",
"score": 0.81,
"story": {
"id": 1044,
"slug": "faq",
"name": "FAQ"
}
}
]
}Changes
No recorded changes to this operation across all 2 revisions of this API.