Scribe · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Scribe Search & Retrieval API

4 actions 4 updates update extends openapi/scribe-search-retrieval-openapi.yml
Derived by API Evangelist Built from the contracts Scribe publishes. Scribe did not publish this file.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-notex-apievangelist-providerx-apievangelist-categoryx-apievangelist-accessx-apievangelist-authx-apievangelist-rate-limitsx-apievangelist-errorsx-apievangelist-conventions

Targets 3

$.info
$.paths['/v1/search/'].post
$.paths['/v1/documents/{id}/'].get

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Scribe Search & Retrieval API
  version: 1.0.0
extends: openapi/scribe-search-retrieval-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: scribe
    x-apievangelist-category: [documentation, knowledge-management, search, ai-ml]
    x-apievangelist-access: enterprise-plan-only
    x-apievangelist-auth: api-key-header
- target: $.info
  update:
    x-apievangelist-rate-limits: rate-limits/scribe-rate-limits.yml
    x-apievangelist-errors: errors/scribe-problem-types.yml
    x-apievangelist-conventions: conventions/scribe-conventions.yml
- target: $.paths['/v1/search/'].post
  update:
    x-apievangelist-note: Primary read entry point for agents — full-text search over the org knowledge base; not paginated (max 20).
- target: $.paths['/v1/documents/{id}/'].get
  update:
    x-apievangelist-note: Returns per-action screenshot URLs for Scribe Documents and Editor.js content for Knowledge Pages.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/scribe-search-retrieval-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.