Headers

• Portal-Url string Required

  A url of public portal:

  • E.g. for a Documentation https://developers.bump.sh
  • E.g. for a Hub https://www.elastic.co/docs/api
  • E.g. for an Organization https://apidocs.lastminute.com/

Query parameters

• query string Required

  Search query string. Matches against page titles, content, and metadata.

• url string

  Filter results by page. Useful to narrow down results of a specific documentation page.

• type string

  Filter results by object type. Useful to narrow down results when looking for a specific kind of documentation page.

  Values are hub, api, guide, group, operation, request, response, model, message, binding, or property.

Responses

• 200 application/json

  Returns matching pages with their URL, title, type, and a text excerpt. Use this to find specific endpoints, or topics when the user asks about a particular feature or concept.

  Hide response attributes Show response attributes object

  • data array[object]
    Hide data attributes Show data attributes object

    • type string

      Values are hub, api, guide, group, operation, request, response, model, message, binding, or property.

    • url string

      Canonical URL of the page

    • title string
    • excerpt string

      Excerpt of the page matching the search query

  • metadata object
    Hide metadata attribute Show metadata attribute object

    • total integer Required

      Total number available results, ignoring filters.