OpenAPI Operation Extractor

Overview

You send an OpenAPI 3.x document in JSON or YAML and get back one small entry per operation: HTTP method, path, operationId, summary, description, tags, parameters, whether it takes a request body, the response codes it declares, and whether it is deprecated. Summaries and descriptions are cut to a length you choose, so the result fits in a planning context instead of swallowing it. We read the document exactly as written and never follow a $ref. For a compliance verdict on the document itself, use schema.validate_openapi. Accepts file input via file_ref — no need to extract file content first.

A full API document rarely fits in a planning context, and most of it is detail you do not need to choose an endpoint. You get the callable surface, and nothing else.

When to use it

Scope

Non-goals

• We never judge whether the document is compliant — that is schema.validate_openapi
• We never generate client or server code from the document
• We never follow a $ref, local or remote, and never fetch anything from the network

Properties

Capabilities

Cost & billing

Flat rate per invocation

File handling

File limits

Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.

How we handle your data

Input schema

Output schema

API contract

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.extract_openapi_operations","input":{"document":"openapi: 3.0.3\ninfo:\n  title: Billing API\n  version: 2.1.0\npaths:\n  /invoices:\n    get:\n      operationId: listInvoices\n      summary: List invoices","includeSecurity":true,"maxDescriptionLength":120}}'

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("schema.extract_openapi_operations", {"document":"openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n    post:\n      summary: Create a pet\n      operationId: createPet"});

Errors

Other limits

Limitations

• We never judge whether the document is compliant — that is schema.validate_openapi
• We never generate client or server code from the document
• We never follow a $ref, local or remote, and never fetch anything from the network
• Deciding whether the document is valid (schema.validate_openapi)
• Generating client or server code from the document
• Reading a plain JSON Schema rather than an OpenAPI document

How to call

POST /v1/execute (requires authentication)

{
  "skillKey": "schema.extract_openapi_operations",
  "input": {
    "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n    post:\n      summary: Create a pet\n      operationId: createPet"
  }
}

Examples

{
  "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths:\n  /pets:\n    get:\n      summary: List all pets\n      operationId: listPets\n    post:\n      summary: Create a pet\n      operationId: createPet"
}

{
  "apiTitle": "Pet Store",
  "operationCount": 2,
  "openapiVersion": "3.0.3",
  "apiVersion": "1.0.0",
  "warnings": [],
  "operations": [
    {
      "path": "/pets",
      "summary": "List all pets",
      "method": "GET",
      "operationId": "listPets"
    },
    {
      "path": "/pets",
      "summary": "Create a pet",
      "method": "POST",
      "operationId": "createPet"
    }
  ]
}

{
  "includeSecurity": true,
  "document": "openapi: '3.0.3'\ninfo:\n  title: Pet Store\n  version: '1.0.0'\npaths:\n  /pets/{petId}:\n    get:\n      summary: Fetch one pet\n      operationId: getPet\n      parameters:\n        - name: petId\n          in: path\n          required: true\n          schema:\n            type: string\n      security:\n        - apiKey: []\n      responses:\n        '200':\n          description: ok",
  "maxDescriptionLength": 80
}

{
  "apiTitle": "Pet Store",
  "operationCount": 1,
  "openapiVersion": "3.0.3",
  "apiVersion": "1.0.0",
  "warnings": [],
  "operations": [
    {
      "method": "GET",
      "responseCodes": [
        "200"
      ],
      "path": "/pets/{petId}",
      "parameters": [
        {
          "name": "petId",
          "in": "path",
          "required": true
        }
      ],
      "operationId": "getPet",
      "summary": "Fetch one pet",
      "security": [
        "apiKey"
      ]
    }
  ]
}

Recommended use cases

• Turn a partner API document into a short list of operations you can plan against
• Answer which endpoints exist, what they take, and which ones are deprecated
• Feed a planner only the operations it needs instead of the whole document

Avoid for

• Deciding whether the document is valid (schema.validate_openapi)
• Generating client or server code from the document
• Reading a plain JSON Schema rather than an OpenAPI document

Related skills

Composable with

Safety & privacy

• Runs without calling any external service.
• Your payloads are never stored permanently.
• Telemetry captures metadata only — never your payload contents.
• We never train models on your payloads.
• No human reviews your payloads.

Tags