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.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Freadmecom%2Freadmecom" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Freadmecom%2Freadmecom" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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

GET STARTED

Start building with ReadMe API

Explore with Jentic One

View OpenAPI Document

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?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the ReadMe API by hand means encoding your key as HTTP basic auth, managing the API specification, category, and registry resources, and handling paging and retries yourself. Through Jentic you install once, import the ReadMe API from the API Directory, store the credential once, and your agent calls it.

Permission scoping

The ReadMe API puts the resource id in the URL path (/api-specification/{id}), so a rule can pin your agent to one specification. You choose the operations it may call, so a destructive one like deleting a specification is not included unless you add it, keeping the agent to reading and updating.

Credential isolation

Your ReadMe API basic credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'get metadata about the current project' or 'list categories', and Jentic returns the matching ReadMe API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

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 your Jentic One instance 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 through Jentic One, the self-hosted execution layer, 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.

Can I limit what my agent is allowed to do with the ReadMe API?

Yes. Because you run Jentic One yourself, you decide which ReadMe API operations your agent may call and which stored credential it uses. Since the resource id sits in the URL path, such as /api-specification/{id}, your own rules can pin the agent to a single specification and grant it only read and update operations like GET /api-specification and PUT /api-specification/{id}. A destructive call such as DELETE /api-specification/{id} is excluded unless you explicitly allow it.

Readmecom ReadMe API

Name: ReadMe API
Brand: ReadMe API
Availability: InStock

AI ReadinessNon-Ready (F)39/100

See full scorecard

Community OpenAPI document · agent-readyDeveloper ToolsMonitoring Observabilitybasic36 EndpointsREST

Know of an official OpenAPI document? Contribute it →

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.

Jentic One on Github View OpenAPI Document

Show dimension breakdown

Foundational Compliance

Base layer of spec validity and structural soundness.

Grade: ASignals: 4

97%

Lint Results

Aggregated quality score from linter diagnostics, weighted by severity.

100%

Resolution Completeness

Percentage of `$ref` references that resolve successfully.

100%

Specification Validity

Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).

60%

Structural Integrity

Structural correctness score based on schema issues using logarithmic dampening.

Developer Experience & Jentic Compatibility

Clarity, completeness, and ingestion readiness for developers and tooling.

Grade: B-Signals: 4

Example Density

How richly the API is illustrated with examples.

100%

Example Validity

Percentage of examples that conform to their schemas.

50%

Response Coverage

Percentage of operations with complete response definitions (success, client error, server error).

100%

Tooling Readiness

Health of API ingestion, bundling, and resolution within Jentic pipelines.

AI-Readiness & Agent Experience

Semantic breadth, depth, and agent comprehension for AI systems.

Grade: D+Signals: 4

32%

Description Coverage

Coverage of descriptions across API elements.

Error Standardization

Coverage of RFC 9457 Problem Details for error responses.

100%

OperationId Quality

Coverage, uniqueness, and casing consistency of operationIds for AI inference.

64%

Summary Coverage

Coverage of summaries across operations/tags/info.

Agent Usability

Functional utility, complexity comfort, and AI orchestration readiness.

Grade: A+Signals: 1

94%

Complexity Comfort

Agent comfort level based on API operational and structural complexity.

Security

Trust, risk posture, and security compliance.

Grade: FSignals: 1

10%

Authentication Strength

Average quality of security schemes based on authentication method strength (weakest link for OAuth2).

AI Discoverability

Findability, semantic richness, and reasoning readiness.

Grade: CSignals: 1

55%

Descriptive Richness

Clarity and depth of descriptions across API elements.

Connect the ReadMe API to your agent

Capabilities

Start building with ReadMe API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs

Readmecom ReadMe API

Jentic AI Readiness Score

ReadMe API

Foundational Compliance

Lint Results

Resolution Completeness

Specification Validity

Structural Integrity

Developer Experience & Jentic Compatibility

Example Density

Example Validity

Response Coverage

Tooling Readiness

AI-Readiness & Agent Experience

Description Coverage

Error Standardization

OperationId Quality

Summary Coverage

Agent Usability

Complexity Comfort

Security

Authentication Strength

AI Discoverability

Descriptive Richness