--- title: Readme API Integration on Truto slug: readme category: Knowledge Management canonical: "https://truto.one/integrations/detail/readme/" --- # Readme API Integration on Truto **Category:** Knowledge Management **Status:** Generally available ## Unified APIs ### Unified Knowledge Base API - **Collections** — - **Files** — - **Page-Content** — Represents the content of a page - **Pages** — Represents the pages, posts, articles in a knowledge base ### Unified Search API - **Search** — Search endpoint for all the apps. ## How it works 1. **Link your customer's Readme account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Readme.** The Proxy API is a 1-to-1 mapping of the Readme API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Power AI support bots with live API documentation** — If you're building an AI-powered developer support tool, let your users connect their ReadMe account so your bot can ingest their full documentation — guides, API references, and code samples — to answer developer questions with accurate, up-to-date responses. - **Surface relevant docs inside support tickets automatically** — Helpdesk and ticketing platforms can search across a customer's ReadMe knowledge base in real time, surfacing the exact API guide or migration doc a support agent needs without leaving the ticket view. - **Sync developer documentation into internal knowledge hubs** — Enterprise search or internal developer portal products can pull ReadMe categories, pages, and content into a unified index, enabling engineering teams to discover API documentation alongside other knowledge sources. - **Feed documentation into RAG pipelines for contextual AI answers** — AI copilot and LLM-powered SaaS products can use structured page content from ReadMe — including MDX with code blocks and callouts — to build high-quality retrieval-augmented generation pipelines grounded in real documentation. - **Tie API observability alerts to relevant documentation** — API monitoring platforms can programmatically look up the exact ReadMe page related to a deprecated or failing endpoint, then proactively surface migration guides or troubleshooting docs to affected developers. ## What you can build - **One-click ReadMe docs sync for AI training** — Let your users authenticate their ReadMe account and automatically sync all guides, API references, and changelogs into your platform's knowledge index on a recurring schedule. - **Contextual documentation widget for support agents** — Embed a sidebar widget that searches a customer's ReadMe hub in real time and displays the most relevant pages and code snippets alongside an open support ticket. - **Structured knowledge base import with category mapping** — Import ReadMe's full category hierarchy as collections, preserving the documentation taxonomy so users can browse or filter content the same way they do in their developer hub. - **Developer-facing search across connected ReadMe projects** — Offer end users a unified search bar that queries their ReadMe documentation and returns ranked results including guides, API endpoint references, and changelog entries. - **MDX content extraction for code sample libraries** — Parse raw MDX page content from ReadMe to extract structured code snippets, parameter tables, and callouts, then display them natively inside your product's UI. ## FAQs ### Which Truto Unified APIs does the ReadMe integration map to? ReadMe maps to Truto's Unified Knowledge Base API (Collections, Files, Page-Content, Pages) and Unified Search API (Search). This covers ReadMe's categories, guides, API reference pages, raw content, and search functionality. ### Are there pre-built tools available for ReadMe today? ReadMe tools are built on request. Once you signal interest, Truto builds and maintains the integration — including auth, pagination, and API-specific handling — so you don't have to. ### How does authentication work for ReadMe integrations? ReadMe uses API key-based authentication. Your end users provide their ReadMe project API key, and Truto securely manages the credential so your application never handles raw secrets directly. ### What kind of content can I extract from ReadMe pages? You can access raw MDX content from ReadMe pages, which includes Markdown text, custom React components like callouts and code blocks, API parameter tables, and embedded code samples — all structured and parseable. ### Does the integration preserve ReadMe's documentation hierarchy? Yes. ReadMe categories map to Collections in the Unified Knowledge Base API, maintaining the sidebar taxonomy of the developer hub. Individual guides and API reference docs map to Pages. ### Can I search across a user's ReadMe documentation programmatically? Yes. The Unified Search API maps to ReadMe's search capabilities, allowing you to pass a query string and receive a ranked list of matching pages, guides, and other content from the connected ReadMe project.