OpenAPI Specification

All APIVoid v2 APIs are described in a single machine-readable OpenAPI 3.0 file: every endpoint, request parameter, response schema, credit cost, and the authentication scheme, generated from the same reference pages present in this documentation.

Download

https://docs.apivoid.com/openapi.json

Download openapi.json – or use the URL above directly in tools that support importing by URL.

Common uses

• Postman or Insomnia. Import the file (or the URL) to get a ready-to-use collection with one request per API, example payloads, and the X-API-Key authorization configured at the collection level for quick testing. Set your API key once in your secure Postman environment and every API request is ready to send.
• Generate an API client. Use OpenAPI Generator to create a typed client in your language, e.g. openapi-generator-cli generate -i https://docs.apivoid.com/openapi.json -g python -o ./apivoid-client
• AI coding assistants. Point your AI assistant or agent at the specification URL so it can write correct integration code with the exact endpoints, parameters, and response fields for faster, more reliable API integrations. See also our llms.txt and llms-full.txt for the full documentation in AI-friendly format.
• Request validation and mocking. Validate outgoing requests against the schemas, or spin up a mock server from the specification while developing, testing edge cases, and verifying integrations before connecting to production APIs, helping catch issues earlier in the development process and reduce integration errors.
• Explore the APIs. Load the file in any OpenAPI viewer (such as Swagger UI or Redoc) to browse all endpoints and schemas in one place, to better understand available API operations.

What it contains

• All v2 API endpoints, each as an HTTPS POST operation with a link back to its reference page.
• Request schemas with required and optional parameters, types, defaults, and descriptions.
• Response schemas with per-field descriptions, plus a complete example response per API.
• Authentication via the X-API-Key header, defined once as the security scheme. See Authentication.
• Credit costs per API in each operation description and in the x-credits-per-request extension. See How credits work.
• Error responses with the shared JSON error format and retry guidance. See API errors & retries.