OpenAPI Snippet

Generate curl from OpenAPI path or JSON spec

API executable

Overview

ID: openapi-snippet

Category: data

Call this tool over HTTP with POST /execute/openapi-snippet. Path, headers, body fields, sample responses, and errors are documented below.

Endpoint

POST

/api/v1/execute/openapi-snippet

Authenticate with X-API-Key or Authorization: Bearer. See Authentication.

API reference

Path, header, and body fields accepted by this execute call.

Name	In	Type	Required	Description
tool	path	string	Yes	Tool identifier used in the execute path. Example: openapi-snippet
X-API-Key	header	string	Yes	Your IT-ToolBox API key. Authorization: Bearer is also accepted. Example: YOUR_API_KEY
Content-Type	header	string	Yes	Must be application/json for execute requests. Example: application/json
input.method	body	string	Yes	Argument for OpenAPI Snippet. Example: get
input.operation_id	body	string	Yes	Argument for OpenAPI Snippet. Example: getUser
input.path	body	string	Yes	Argument for OpenAPI Snippet. Example: /users/{id}

Code examples

shell

curl -X POST /api/v1/execute/openapi-snippet \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "method": "get",
    "operation_id": "getUser",
    "path": "/users/{id}"
  }
}'

Tool UI

Open the interactive experience to try the tool without writing HTTP clients.

Open tool UI

Back to tools catalog