# Public API Docs & Integration Readiness Agent (`jacksu/public-api-docs-readiness-agent`) Actor

Find public API documentation, OpenAPI/Swagger, SDK, authentication, webhook, status, changelog, and rate-limit evidence with useful-result pricing.

- **URL**: https://apify.com/jacksu/public-api-docs-readiness-agent.md
- **Developed by:** [jack su](https://apify.com/jacksu) (community)
- **Categories:** Developer tools, Automation, AI
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $5.00 / 1,000 useful api docs readiness results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Public API Docs & Integration Readiness Agent

Find public API documentation and integration-readiness evidence from a website
or developer docs URL. The Actor returns API reference links, OpenAPI/Swagger
hints, SDK links, authentication, rate-limit, webhook, status, changelog,
pagination, error-code, and endpoint-sample evidence.

### Pricing Design

The intended pay-per-event setup is:

- `apify-actor-start`: a tiny run-start fee
- `useful-api-docs-result`: charged only for useful public API documentation
  readiness records
- no `apify-default-dataset-item`

If `focusCapabilityTerms` are supplied, useful-result charging requires at
least one matched capability term. Invalid inputs, duplicate equivalent URLs,
private-network targets, query/fragment/token inputs, weak pages, and failed
fetches should not charge the useful event.

### Boundaries

This Actor is not a crawler, article extractor, feed parser, sitemap planner,
pricing extractor, contact finder, or page-change monitor. It fetches the input
page plus a small bounded number of same-organization API/docs candidate pages.
It does not log in, use cookies, render JavaScript, call third-party APIs, run
code snippets, bypass paywalls, or fetch arbitrary external links.

# Actor input Schema

## `docsOrSiteUrls` (type: `array`):

Public website, API docs, or developer documentation URLs. Query parameters, fragments, credentials, path params, and private-network addresses are rejected.

## `focusCapabilityTerms` (type: `array`):

Optional terms to match in API documentation evidence, such as webhook, oauth, python, or rate limit. When supplied, useful-result charging requires at least one match.

## `maxDocsPages` (type: `integer`):

Maximum input plus same-organization API/docs candidate pages to fetch per URL.

## `requestTimeoutSecs` (type: `integer`):

Maximum time in seconds to wait for each public documentation page request.

## Actor input object example

```json
{
  "docsOrSiteUrls": [
    "https://docs.github.com/en/rest"
  ],
  "focusCapabilityTerms": [],
  "maxDocsPages": 3,
  "requestTimeoutSecs": 20
}
```

# Actor output Schema

## `datasetId` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("jacksu/public-api-docs-readiness-agent").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("jacksu/public-api-docs-readiness-agent").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call jacksu/public-api-docs-readiness-agent --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,jacksu/public-api-docs-readiness-agent"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/0heXpNk78OsJ7VJey/builds/eZz6dGniszEeIpNI7/openapi.json