Redocly

Run JavaScript in a sandbox against the documentation at https://redocly.com. The script calls the sandbox functions on the global `site` object. The only extra global is `site` - there is no `fetch`, `console`, `setTimeout`, `require`, or Node.js API; all I/O goes through `site`. Workflow - minimize round-trips; one `discover` call plus one `execute` call covers most requests: 1. Analyze the request and decide which sandbox functions it needs. 2. Call `discover` with those names to get their exact TypeScript signatures - inputs, result shapes, and a worked example. NEVER call `execute` with guessed function names, parameter names, enum values, or result field names: read fields off the declared return types, not from assumptions. 3. Batch everything into a SINGLE script: chain function calls, pass one call's output into the next, process results in plain JavaScript, and `return` only what the request needs. Functions for `execute` scripts (signatures come from `discover`): - listApis — List the available APIs. - getEndpoints — Get all endpoints for an API. - getEndpointInfo — Get the details of an endpoint. - getSecuritySchemes — Get the security schemes for an API. - getFullApiDescription — Get the complete OpenAPI description. - search — Search the documentation. - listPages — List the docs navigation, one level per call. - getPage — Read a docs page as Markdown, in line windows. - grepPages — Find the docs lines that contain a text.

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "JavaScript to run in the sandbox. Return a value to receive it as the result.",
      "minLength": 1
    },
    "description": {
      "type": "string",
      "description": "A short, human-readable summary of what this code does.",
      "minLength": 1
    }
  },
  "required": [
    "code",
    "description"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "result": {
      "description": "The value the code returned, as JSON"
    },
    "error": {
      "type": "string",
      "description": "Why the code failed. Set only on a failed call"
    }
  }
}

Get the exact TypeScript signatures of the sandbox functions that `execute` scripts can call. Analyze the user request first, then pass `names` with only the functions the request needs (every name is listed in this input schema / description); omit `names` only when you cannot tell which functions apply. Always call this before your first `execute` and never guess signatures. Request every function the task may need in ONE call instead of calling this repeatedly.

{
  "type": "object",
  "properties": {
    "names": {
      "type": "array",
      "description": "Names of the sandbox functions to discover: listApis, getEndpoints, getEndpointInfo, getSecuritySchemes, getFullApiDescription, search, listPages, getPage, grepPages. Omit to discover all of them.",
      "items": {
        "type": "string",
        "enum": [
          "listApis",
          "getEndpoints",
          "getEndpointInfo",
          "getSecuritySchemes",
          "getFullApiDescription",
          "search",
          "listPages",
          "getPage",
          "grepPages"
        ]
      },
      "nullable": true
    }
  },
  "required": [],
  "additionalProperties": false
}

Report a documentation page that is wrong or incomplete. Use it when the user reports a problem with a page on this site, or agrees to report a problem that you found. Do not use it for product bugs or support questions.

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "Path or URL of the documentation page the feedback is about (e.g. /guides/auth)",
      "minLength": 1,
      "maxLength": 1000
    },
    "summary": {
      "type": "string",
      "description": "One sentence that names what is wrong with the page",
      "minLength": 1,
      "maxLength": 500
    },
    "details": {
      "type": "string",
      "description": "Expected versus actual behavior, missing steps, or the snippet that failed",
      "maxLength": 4000,
      "nullable": true
    },
    "targetFeature": {
      "type": "string",
      "description": "The API or feature the page documents",
      "maxLength": 500,
      "nullable": true
    }
  },
  "required": [
    "path",
    "summary"
  ],
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "page": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "status",
    "page",
    "message"
  ]
}