Publish Search a documentation
POST
/control-plane/api/v1/documentation/{organization_id}/{documentation_id}/search

Authentication

API Key (BearerAuth)

  • Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID


documentation_idstringrequired

Documentation ID


Request Body

Search query

Required

limitinteger

querystringrequired

version_idstring

Example:

{
  "limit": 0,
  "query": "string",
  "version_id": "string"
}

Responses

200
Ranked results

Example:

{
  "key": "value"
}
400
Bad request

Example:

{
  "key": "value"
}
500
Internal server error

Example:

{
  "key": "value"
}