OpenAPI

01File

This is a standard OpenAPI 3.1 file. It describes five methods, the format of request and response bodies, and the authorization scheme.

02What is in the file

The main response codes are shown; the full list is in the “Error codes” section. Webhooks are not part of the file: you give their address in the generation request, and the event format is described in the “Webhooks” section.

03How to use it

1. Open the file in Postman or Insomnia

   In the app, choose “Import,” paste the link to the file or drag in the downloaded openapi.json. The methods appear as a group: all that remains is to add your key to the authorization settings.

2. Generate a client for your language

   Any generator that understands OpenAPI 3.1 will do. For example, types for TypeScript:

   TypeScriptCopy

   npx openapi-typescript openapi.json -o rendergrid.d.ts

   A client for Python (requires Java):

   PythonCopy

   npx @openapitools/openapi-generator-cli generate \
     -i openapi.json -g python -o ./rendergrid-client

3. Check the response with a live request

   The file describes fields and codes but does not replace testing. Send one request from the quickstart and compare the response with the description.

04Authorization

The file describes two schemes, and both accept the same key:

For where to get a key and how to keep it safe, see the “Keys and authentication” section.

05Version and changes

The API version is part of the address: /api/public/v1. Within a version, new fields and new error codes can appear in responses, so parse a response tolerantly: ignore unfamiliar fields, and handle an unfamiliar code by its type.

What changed and when: see the “What’s new” page.

FAQFrequently asked questions