OpenAPI Launch Pack API

First call

Start with a realistic request you can inspect.

curl -X POST 'https://openapi-launch-pack-api.linkridge.net/v1/openapi/analyze' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: <your-api-key>' \
  -d '{
  "target_server_url": "https://demo-api.example.com",
  "spec": {
    "openapi": "3.0.3",
    "info": {
      "title": "Demo API",
      "version": "1.0.0",
      "description": "A small API used to demonstrate launch-pack generation."
    },
    "paths": {
      "/health": {
        "get": {
          "summary": "Health check",
          "operationId": "health",
          "responses": {
            "200": {
              "description": "OK"
            }
          }
        }
      }
    }
  }
}'

Prefer marketplace auth? Open in RapidAPI for plans, keys, and interactive testing.

Example response

{
  "valid": true,
  "title": "Demo API",
  "summary": {
    "operation_count": 1,
    "path_count": 1,
    "has_security": false
  },
  "issues": [],
  "rapidapi": {
    "name": "Demo API",
    "short_description": "A small API used to demonstrate launch-pack generation.",
    "support_email": "api-support@makersridge.com"
  },
  "endpoint_summaries": [
    {
      "method": "GET",
      "path": "/health",
      "summary": "Health check",
      "operationId": "health"
    }
  ],
  "curl_examples": [
    {
      "name": "GET /health",
      "command": "curl --request GET 'https://demo-api.example.com/health'"
    }
  ],
  "postman_collection": {
    "info": {
      "name": "Demo API"
    },
    "item": [
      {
        "name": "Health check",
        "request": {
          "method": "GET",
          "url": "https://demo-api.example.com/health"
        }
      }
    ]
  },
  "platform_launch_packs": {
    "rapidapi": {
      "label": "RapidAPI launch pack",
      "readiness_score": 100,
      "remediation_steps": []
    },
    "postman": {
      "item_count": 1,
      "remediation_steps": []
    },
    "sdk_readiness": {
      "generator_notes": [
        "operationId values are present; keep them stable before SDK generation."
      ]
    },
    "docs_site": {
      "page_outline": [
        {
          "section": "Hero",
          "purpose": "Explain the API and the first useful call."
        },
        {
          "section": "First call",
          "purpose": "Show GET /health as the smallest smoke path."
        }
      ]
    }
  },
  "normalized_openapi": {
    "servers": [
      {
        "url": "https://demo-api.example.com"
      }
    ]
  }
}