> ## Documentation Index > Fetch the complete documentation index at: https://docs.iotools.cloud/llms.txt > Use this file to discover all available pages before exploring further. # Get tool schema > Input and output JSON Schema for one tool, plus what a run costs your key. Use it after `search` to learn a tool's exact contract without pulling the full catalog. Free: this call costs no credits. ## OpenAPI ````yaml https://api.iotools.cloud/v1/openapi get /v1/tool/{slug} openapi: 3.1.0 info: title: iotools.cloud API version: 1.0.0 description: >- Run any iotools.cloud tool over HTTP. Authenticate with `Authorization: Bearer iot_live_…`. **Only `POST /v1/tool/{slug}` costs credits.** Every GET here — the catalog, a tool's schema, your balance — is free. A tool call is charged its own weight or your plan's per-call minimum, whichever is larger; `x-iotools-credit-cost` on each operation is quoted at the free-tier minimum, and `GET /v1/tools/list` returns the exact figure for your key. `GET /v1/me/credits` reports what you have left, and `GET /v1/me/usage` reports what it went on. Failures are RFC 9457 problem documents — branch on `code`. servers: - url: https://api.iotools.cloud description: Production security: - bearerAuth: [] tags: - name: Catalog description: Find a tool and read its contract. Free. - name: Converters description: >- Convert between formats, encodings, and units — Base64, CSV and JSON, timestamps, and more. Fast, free, and processed right in your browser. - name: Formatters description: >- Format, beautify, minify, and validate code and data — JSON, HTML, CSS, SQL, and regex. Clean up messy input in one click, with nothing to upload. - name: Generators description: >- Generate exactly what you need and on demand — passwords, UUIDs, QR codes, hashes, random numbers, and more. Secure, instant, and free. - name: Calculators description: >- Crunch the numbers fast — from everyday math to specialized conversions and unit work. Free online calculators that run entirely in your browser. - name: Editors description: >- Edit and transform text, code, and images with quick, focused editors that run entirely in your browser — nothing to install, and no sign-up needed. - name: Utilities description: >- Everyday developer and web utilities — DNS and IP lookups, redirect and certificate checkers, and other quick diagnostics. Free and privacy-friendly. - name: Account description: Your key's allowance, limits and usage history. paths: /v1/tool/{slug}: get: tags: - Catalog summary: Get tool schema description: >- Input and output JSON Schema for one tool, plus what a run costs your key. Use it after `search` to learn a tool's exact contract without pulling the full catalog. Free: this call costs no credits. operationId: get_tool_schema parameters: - name: slug in: path required: true schema: type: string description: 'The tool''s slug. Nested slugs keep their slash: `ai-writer/story`.' example: case-converter responses: '200': description: The tool's contract. content: application/json: schema: type: object required: - slug - title - description - category - credit_cost - schema properties: slug: type: string description: >- The tool's identifier — use it in `GET /v1/tool/{slug}` and `POST /v1/tool/{slug}`. title: type: string description: Human-readable tool name. description: type: string description: One-line summary of what the tool does. category: type: string description: One of the six catalog categories, e.g. `converters`. credit_cost: type: integer description: >- Credits a run of this tool costs YOUR key, floor included — so it already reflects your plan and can be compared directly against `GET /v1/me/credits`. credit_cost_multiplier_field: type: string description: >- Present only on per-unit tools: `credit_cost` is then a rate, and a run costs it times the value of this input field. schema: type: object required: - input - output properties: input: type: object description: JSON Schema for the tool's inputs. output: type: object description: JSON Schema for the tool's outputs. examples: type: array description: >- Worked examples, omitted when the tool declares none. `expected` is present only for deterministic tools — AI/random output has no fixed answer to print. items: type: object required: - label - inputs properties: label: type: string description: Human-readable name for the example. inputs: type: object description: A complete, valid request body. expected: type: object description: The exact `outputs` this request produces. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/ToolNotAllowed' '404': description: No such tool. content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/tool_not_found title: type: string description: Short human-readable summary of the failure. examples: - Tool not found status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - tool_not_found detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. example: type: https://iotools.cloud/docs/errors/tool_not_found title: Tool not found status: 404 code: tool_not_found detail: No tool with the slug "no-such-tool". request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/KeyLookupFailed' '503': $ref: '#/components/responses/ApiUnconfigured' security: - bearerAuth: [] components: responses: Unauthorized: description: Missing or invalid API key. content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/invalid_api_key title: type: string description: Short human-readable summary of the failure. examples: - Invalid API key status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - invalid_api_key detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. example: type: https://iotools.cloud/docs/errors/invalid_api_key title: Invalid API key status: 401 code: invalid_api_key detail: 'Provide ''Authorization: Bearer ''.' request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 ToolNotAllowed: description: Tool exists but has no API surface. content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/tool_not_allowed title: type: string description: Short human-readable summary of the failure. examples: - Tool not available over the API status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - tool_not_allowed detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. example: type: https://iotools.cloud/docs/errors/tool_not_allowed title: Tool not available over the API status: 403 code: tool_not_allowed detail: >- "Background Remover" is available on iotools.cloud but has no API endpoint. request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 RateLimited: description: Per-minute rate limit exceeded. headers: Retry-After: description: Seconds to wait before retrying (RFC 9110 delta-seconds). schema: type: integer content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/rate_limited title: type: string description: Short human-readable summary of the failure. examples: - Rate limit exceeded status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - rate_limited detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. retry_after: type: integer description: >- Seconds until the window resets — the same value as the `Retry-After` header. example: type: https://iotools.cloud/docs/errors/rate_limited title: Rate limit exceeded status: 429 code: rate_limited detail: Too many requests. Retry in 30s. request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 retry_after: 30 KeyLookupFailed: description: Unexpected server error. content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/internal_error title: type: string description: Short human-readable summary of the failure. examples: - Internal error status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - internal_error detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. example: type: https://iotools.cloud/docs/errors/internal_error title: Internal error status: 500 code: internal_error detail: Key lookup failed request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 ApiUnconfigured: description: API not configured on this deployment. content: application/problem+json: schema: type: object description: >- RFC 9457 problem document, served as application/problem+json. Branch on `code`; `title` is human prose and may be reworded without notice. Some failures add extension members — `fields` on validation errors, `retry_after` on 429s, `credits_used`/`credits_remaining` on billing-adjacent failures — documented on the responses that carry them. required: - type - title - status - code properties: type: type: string format: uri description: Stable documentation URI for this failure. examples: - https://iotools.cloud/docs/errors/api_unconfigured title: type: string description: Short human-readable summary of the failure. examples: - API not configured status: type: integer description: HTTP status code, matching the response's own status. code: type: string description: >- Stable machine-readable error code — branch on this, not `title`. enum: - api_unconfigured detail: type: string description: Human explanation of this occurrence. request_id: type: string description: Correlation id, also sent as x-request-id. example: type: https://iotools.cloud/docs/errors/api_unconfigured title: API not configured status: 503 code: api_unconfigured detail: DATABASE_URL is not set request_id: e4042b29-8f1e-4c7a-9b52-6f0d1a3c7e11 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: iot_live_… ````