ReadMe
API documentation platform with interactive developer hubs
Actions
| Name | Description |
|---|---|
create_docCreate a new documentation page | Create a new documentation page |
get_docGet a documentation page by slug | Get a documentation page by slug |
list_categoriesList all documentation categories | List all documentation categories |
get_api_specGet uploaded API specifications | Get uploaded API specifications |
custom_api_callMake a custom API call to the ReadMe API | Make a custom API call to the ReadMe API |
Triggers
| Name | Description |
|---|---|
doc_updatedTriggers when a documentation page is updated | Triggers when a documentation page is updated |
Quick Start
import { WeavzClient } from '@weavz/sdk'
const weavz = new WeavzClient({ apiKey: 'wvz_...' })
const result = await weavz.actions.execute({
integrationName: 'readme-io',
actionName: 'create_doc',
input: { /* ... */ },
connectionId: 'conn_id',
workspaceId: 'ws_id',
})Related Integrations
Works well with
Frequently Asked Questions
How do I connect ReadMe to my app?
Use Weavz Hosted Connect for Basic Auth authentication. Install the SDK, create a connection through the connect portal or API, then execute actions programmatically.
What actions does ReadMe support?
ReadMe supports 5 actions including Create Doc, Get Doc, List Categories, Get API Specification, Custom API Call.
Can I use ReadMe with AI agents?
Yes. Add ReadMe to an MCP server in TOOLS mode or CODE mode. CODE mode provides 80-98% context reduction with 3 meta-tools for efficient agent access.
What authentication does ReadMe use?
ReadMe uses Basic Auth. Weavz handles token management, refresh, and secure credential storage automatically.
How much does the ReadMe integration cost?
The ReadMe integration is included on all Weavz plans including the free tier with 1,000 actions per month. No credit card required.
What triggers does ReadMe support?
ReadMe supports 1 triggers including Doc Updated.
Connect ReadMe in 2 minutes
Get 1,000 free actions every month. No credit card required.