Developer Docs Extraction | Apiosk Gateway

About

Developer Docs Extraction helps an AI agent understand a third-party API fast: extract-openapi-metadata parses an OpenAPI 3.x or Swagger 2.0 schema (given as a URL or inline) into title, version, server URLs, auth methods, endpoint count and tags — the value over a plain JSON.parse is that it normalizes both spec versions; extract-api-docs-summary scrapes an API docs page for the auth method, base URL (preferring code blocks), rate limits, pricing hints and a rough integration_difficulty. The difficulty is a subjective, signal-count heuristic, not a hard measurement. Pay per request via x402; no API key needed from the caller.

Base URL

https://gateway.apiosk.com/developer-extraction

Technical Specs

Auth Methodx402

Response FormatJSON

Endpoints2

Endpoints

Method	Path	Description	Cost
POST	/extract-api-docs-summary	Summarize an API documentation page: api_name, auth_method, base_url (code blocks preferred), rate_limits, pricing_hints and a rough integration_difficulty (easy/medium/hard). Keyword heuristic, no LLM; difficulty is subjective, not a hard measure.	$0.07 default	View details
POST	/extract-openapi-metadata	Extract metadata (title, version, server URLs, auth methods, endpoint count, tags) from an OpenAPI 3.x or Swagger 2.0 schema. Pass the schema inline (no fetch) or a url to it. Supporting both spec versions is the value over a plain parse.	$0.07 default	View details

Endpoint documentation

POST/extract-api-docs-summary

$0.07 default

Description

Summarize an API documentation page: api_name, auth_method, base_url (code blocks preferred), rate_limits, pricing_hints and a rough integration_difficulty (easy/medium/hard). Keyword heuristic, no LLM; difficulty is subjective, not a hard measure.

Pricing

$0.07 default

Request schema

{
  "properties": {
    "url": {
      "description": "API docs page URL, e.g. \"https://docs.example.com\".",
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "type": "object"
}

Response schema

{
  "properties": {
    "api_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "auth_method": {
      "type": [
        "string",
        "null"
      ]
    },
    "base_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "integration_difficulty": {
      "enum": [
        "easy",
        "medium",
        "hard"
      ],
      "type": "string"
    },
    "pricing_hints": {
      "type": [
        "string",
        "null"
      ]
    },
    "rate_limits": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object"
}

Example request

{
  "url": "https://open-meteo.com/en/docs"
}

Example response

{
  "api_name": "Example API",
  "auth_method": "API key",
  "base_url": "https://api.example.com",
  "integration_difficulty": "medium",
  "pricing_hints": "Free and paid plans available",
  "rate_limits": "100 requests per minute"
}

POST/extract-openapi-metadata

$0.07 default

Description

Extract metadata (title, version, server URLs, auth methods, endpoint count, tags) from an OpenAPI 3.x or Swagger 2.0 schema. Pass the schema inline (no fetch) or a url to it. Supporting both spec versions is the value over a plain parse.

Pricing

$0.07 default

Request schema

{
  "anyOf": [
    {
      "required": [
        "schema"
      ]
    },
    {
      "required": [
        "url"
      ]
    }
  ],
  "description": "Provide schema (inline, preferred) or url.",
  "properties": {
    "schema": {
      "description": "The OpenAPI/Swagger schema object itself; takes precedence over url.",
      "type": "object"
    },
    "url": {
      "description": "URL to an OpenAPI/Swagger JSON schema.",
      "type": "string"
    }
  },
  "type": "object"
}

Response schema

{
  "properties": {
    "auth_methods": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "endpoint_count": {
      "type": "integer"
    },
    "openapi_version": {
      "description": "e.g. \"3.1.0\", or \"2.0\" for Swagger.",
      "type": [
        "string",
        "null"
      ]
    },
    "server_urls": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "tags": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "title": {
      "type": [
        "string",
        "null"
      ]
    },
    "version": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "type": "object"
}

Example request

{
  "schema": {
    "info": {
      "title": "Example API",
      "version": "1.0.0"
    },
    "openapi": "3.1.0",
    "paths": {}
  }
}

Example response

{
  "auth_methods": [],
  "endpoint_count": 0,
  "openapi_version": "3.1.0",
  "server_urls": [],
  "tags": [],
  "title": "Example API",
  "version": "1.0.0"
}