Search documentation

POST

/search

• Production
• Local development

Performs a full-text search across all published documentation pages.

Request Body ^required

object

query

required

string

>= 2 characters <= 200 characters

Example

install starlight

limit

integer

default: 10 >= 1 <= 50

Responses

200

Search results

object

results

Array<object>

object

slug

string

Example

guides/getting-started

title

string

Example

Getting Started

excerpt

string

Example

...run <mark>npm create astro</mark> to scaffold a new project...

score

number format: float

Example

0.92

total

integer

Example

5

400

Invalid search query

object

code

integer

Example

400

message

string

Example

Validation failed.

details

string

Example

Field 'query' must be at least 2 characters.