# OpenAPI to LLM Context (`orbiscribe/openapi-to-llm-context`) Actor Convert OpenAPI and Swagger specs into LLM-ready endpoint Markdown, API reference JSONL, schema summaries, and agent context. - **URL**: https://apify.com/orbiscribe/openapi-to-llm-context.md - **Developed by:** [Orbiscribe Labs](https://apify.com/orbiscribe) (community) - **Categories:** AI, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing $6.00 / 1,000 openapi spec converteds 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/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 ## OpenAPI to LLM Context Use this Actor when you have an OpenAPI or Swagger spec and need compact context for coding agents, API copilots, documentation QA, or internal developer tools. It parses public spec URLs or inline specs, normalizes endpoint records, summarizes schemas, and writes Markdown and JSONL artifacts that are easier to feed into LLM workflows than a raw spec file. ### What you get - Dataset rows for API endpoints. - Endpoint method, path, operation ID, summary, tags, parameters, response codes, deprecated flag, auth hint hash, and Markdown. - Key-value outputs: `LLM_CONTEXT.md`, `API_REFERENCE_JSONL`, `ENDPOINTS_MARKDOWN`, `ENDPOINT_CHUNKS_JSONL`, `SCHEMA_SUMMARY`, `BUYER_BRIEF`, and `RUN_SUMMARY`. ### Common workflows - Give a coding agent concise API context without pasting a full spec. - Export endpoint JSONL for API search or internal docs tools. - Review deprecated endpoints and schema names from multiple specs. - Convert partner APIs into a standard LLM-ready reference format. ### Input Provide `specUrls` for public JSON/YAML specs, or pass small specs in `inlineSpecs`. Use `includeSchemas`, `includeDeprecated`, and `maxOperations` to keep the output focused. The default run is a dry run. It emits a small demo API without fetching live specs or calling custom pay-per-event charges. ### Pricing Recommended monetization: Pay per Event at **$0.006** per `openapi-llm-spec`. When pay-per-event pricing is enabled, dry runs are uncharged and free-plan callers get the first 25 processed specs without this Actor's custom event charge. ### Limits and compliance Use public specs or specs you are allowed to process. This Actor does not call the API described by the spec; it only converts the spec document. # Actor input Schema ## `specUrls` (type: `array`): Public OpenAPI or Swagger JSON/YAML URLs. ## `inlineSpecs` (type: `array`): Optional inline OpenAPI/Swagger specs as JSON objects. ## `includeSchemas` (type: `boolean`): Include schema summaries from OpenAPI components. ## `includeDeprecated` (type: `boolean`): Include deprecated OpenAPI operations in the endpoint output. ## `maxOperations` (type: `integer`): Maximum number of OpenAPI operations to include per run. ## `requestTimeoutMs` (type: `integer`): Per-request timeout in milliseconds. ## `dryRun` (type: `boolean`): Emit bundled demo API context without fetching or charging events. ## Actor input object example ```json { "specUrls": [ { "url": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml", "name": "Demo Petstore API" } ], "inlineSpecs": [], "includeSchemas": true, "includeDeprecated": true, "maxOperations": 500, "requestTimeoutMs": 15000, "dryRun": true } ```` # Actor output Schema ## `results` (type: `string`): No description ## `llmContext` (type: `string`): No description ## `apiReferenceJsonl` (type: `string`): No description ## `endpointMarkdown` (type: `string`): No description ## `endpointChunksJsonl` (type: `string`): No description ## `schemaSummary` (type: `string`): No description ## `buyerBrief` (type: `string`): No description ## `runSummary` (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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("orbiscribe/openapi-to-llm-context").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("orbiscribe/openapi-to-llm-context").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).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 orbiscribe/openapi-to-llm-context --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=orbiscribe/openapi-to-llm-context", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "OpenAPI to LLM Context", "description": "Convert OpenAPI and Swagger specs into LLM-ready endpoint Markdown, API reference JSONL, schema summaries, and agent context.", "version": "0.1", "x-build-id": "pSolT43BB23hEbO5L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/orbiscribe~openapi-to-llm-context/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-orbiscribe-openapi-to-llm-context", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/orbiscribe~openapi-to-llm-context/runs": { "post": { "operationId": "runs-sync-orbiscribe-openapi-to-llm-context", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/orbiscribe~openapi-to-llm-context/run-sync": { "post": { "operationId": "run-sync-orbiscribe-openapi-to-llm-context", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "specUrls": { "title": "OpenAPI spec URLs", "type": "array", "description": "Public OpenAPI or Swagger JSON/YAML URLs.", "default": [ { "url": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml", "name": "Demo Petstore API" } ] }, "inlineSpecs": { "title": "Inline specs", "type": "array", "description": "Optional inline OpenAPI/Swagger specs as JSON objects.", "default": [] }, "includeSchemas": { "title": "Include schemas", "type": "boolean", "description": "Include schema summaries from OpenAPI components.", "default": true }, "includeDeprecated": { "title": "Include deprecated operations", "type": "boolean", "description": "Include deprecated OpenAPI operations in the endpoint output.", "default": true }, "maxOperations": { "title": "Max operations", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of OpenAPI operations to include per run.", "default": 500 }, "requestTimeoutMs": { "title": "Request timeout ms", "minimum": 1000, "maximum": 60000, "type": "integer", "description": "Per-request timeout in milliseconds.", "default": 15000 }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Emit bundled demo API context without fetching or charging events.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```