Readmecom ReadMe API
★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilitybasic36 EndpointsREST
For Agents
Programmatically get metadata about the current project, retrieve an entry from the api registry. Covers 36 operations with basic authentication.
Use for: I need to metadata about the current project, I want to an entry from the api registry, Search for upload an api specification, Find all api specification metadata
Not supported: Does not handle payments, communications, or crm — use for developer tools only.
ReadMe API v1 for managing documentation projects, categories, docs, changelogs, custom pages, versions, and API specifications. The API exposes 36 endpoints secured with basic authentication.
Install Jentic One Beta
Connect the ReadMe API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ReadMe API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with ReadMe API.
Get metadata about the current project
Retrieve an entry from the API Registry
Upload an API specification
Update an API specification
Delete an API specification
Create a category
Use Cases
Patterns agents use ReadMe API for, with concrete tasks.
★ Developer Tools Operations
Use the ReadMe API to perform developer tools operations programmatically. The API provides 36 endpoints covering core functionality including get metadata about the current project, retrieve an entry from the api registry, upload an api specification.
Call GET / to get metadata about the current project
Automated project Management
Automate project operations by combining multiple ReadMe API endpoints. Agents can retrieve an entry from the api registry and then upload an api specification in a single workflow.
Call GET /api-registry/{uuid} to retrieve an entry from the api registry, then verify the result
AI Agent Integration via Jentic
AI agents discover and call ReadMe API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.
Search Jentic for 'get metadata about the current project', load the operation schema, and execute with Jentic-managed credentials
Key Endpoints
36 endpoints — readme api v1 for managing documentation projects, categories, docs, changelogs, custom pages, versions, and api specifications.
METHOD
PATH
DESCRIPTION
GET
/
Get metadata about the current project
GET
/api-registry/{uuid}
Retrieve an entry from the API Registry
POST
/api-specification
Upload an API specification
GET
/api-specification
Get API specification metadata
PUT
/api-specification/{id}
Update an API specification
DELETE
/api-specification/{id}
Delete an API specification
POST
/categories
Create a category
GET
/categories
Get all categories
GET
/
Get metadata about the current project
GET
/api-registry/{uuid}
Retrieve an entry from the API Registry
POST
/api-specification
Upload an API specification
GET
/api-specification
Get API specification metadata
PUT
/api-specification/{id}
Update an API specification
DELETE
/api-specification/{id}
Delete an API specification
POST
/categories
Create a category
GET
/categories
Get all categories
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
ReadMe API basic credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.
Intent-based discovery
Agents search by intent (e.g., 'get metadata about the current project') and Jentic returns the matching ReadMe API operation with its input schema, so the agent can call the right endpoint without browsing docs.
Time to first call
Direct ReadMe API integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Github
Alternative developer tools API
Choose Github when you need a different approach to developer tools operations
FAQs
Specific to using ReadMe API through Jentic.
What authentication does the ReadMe API use?
The ReadMe API uses HTTP Basic authentication. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and injected at execution time, so raw secrets never enter the agent context.
Can I get metadata about the current project with the ReadMe API?
Yes. Use the GET / endpoint. The API returns structured JSON responses that agents can parse and act on directly.
What are the rate limits for the ReadMe API?
Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.
How do I get metadata about the current project through Jentic?
Install the Jentic SDK with pip install jentic, authenticate at https://app.jentic.com/sign-up, then search for 'get metadata about the current project'. Jentic returns the matching ReadMe API operation with its input schema. Load the schema and execute the call — credentials are injected automatically.
How many endpoints does the ReadMe API have?
The ReadMe API exposes 36 endpoints covering project, api-registry, api-specification operations.
GET STARTED