Search

Search operations

Changed on

Lexical (full-text) search over registered API operations.

post/search

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /search
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token)

Request body

apisstring[] nullable

Restrict results to these APIs. Each entry is a 'vendor[/name[/version]]' identifier of an imported API (e.g. 'github-com/api-github-com/1.1.4'); vendor and name are normalized like ingest, so raw spellings such as 'stripe.com/api' also resolve. The legacy colon-separated form 'vendor[:name[:version]]' is also accepted.

cursorstring nullable

Opaque cursor from a previous page's next_cursor; omit for the first page.

limitinteger

Maximum number of results to return (1-100).

querystring required

Free-text search query; must not be empty.

revision_pinsobject nullable

Pin specific APIs to a revision for this search. Keys are full 'vendor/name/version' identifiers (colon-separated also accepted); values are revision UUIDs.

Example request

{
  "apis": [
    "stripe.com/stripe"
  ],
  "cursor": "eyJkIjogMC4yODE2LCAiaWQiOiAib3BfZjkyZDY5ZjE2MjFmMzgxYmNlOGFhZmY0NzA1M2M2MWIwNjlmZmUzNCJ9",
  "limit": 10,
  "query": "list recent charges",
  "revision_pins": {
    "stripe.com/stripe/2024-04-10": "3f2b8c1e-7d4a-4e9b-a6c5-1d2e3f4a5b6c"
  }
}

Response

Successful Response

has_moreboolean required

Whether more results exist after this page.

next_cursorstring nullable

Cursor for the next page; null when there are no more results.

Example response

{
  "data": [
    {
      "_links": {
        "inspect": "https://jentic.example.com/inspect?id=GET%20https%3A%2F%2Fapi.stripe.com%2Fv1%2Fcharges"
      },
      "api": {
        "host": "api.stripe.com",
        "name": "stripe",
        "vendor": "stripe.com",
        "version": "2024-04-10"
      },
      "description": "Returns a list of charges you've previously created, newest first.",
      "method": "GET",
      "name": "List all charges",
      "operation_id": "op_f92d69f1621f381bce8aaff47053c61b069ffe34",
      "relevance_score": 0.87,
      "target": "GET:https://api.stripe.com/v1/charges",
      "type": "operation",
      "url": "https://api.stripe.com/v1/charges"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJkIjogMC4yODE2LCAiaWQiOiAib3BfZjkyZDY5ZjE2MjFmMzgxYmNlOGFhZmY0NzA1M2M2MWIwNjlmZmUzNCJ9"
}

Changes