16Referencia
OpenAPI
La descripción de todos los endpoints de la API pública en un solo archivo. Cárgalo en Postman o en un generador de clientes y los endpoints, los campos y los códigos de respuesta aparecerán solos.
Archivo
Es un archivo OpenAPI v3.1 estándar. Describe cinco endpoints, el formato de los cuerpos de las solicitudes y las respuestas, y el esquema de autorización.
Qué contiene el archivo
POST/images/generateCrear una imagen
X-Idempotency-Key. Responde 202 con el identificador de la tarea.GET/creations/{id}Estado y resultado
error y failure.POST/uploadsSubir una imagen de referencia
file_id, que es válido durante 24 horas.GET/modelsCatálogo y precios
GET/balanceSaldo
Se muestran los códigos de respuesta principales; la lista completa está en la sección «Códigos de error». Los webhooks no forman parte del archivo: la dirección para ellos la indicas en la solicitud de generación, y el formato del evento se describe en la sección «Webhooks».
Cómo usarlo
Abre el archivo en Postman o Insomnia
En la aplicación elige «Import», pega el enlace al archivo o arrastra el
openapi.jsondescargado. Los endpoints aparecerán agrupados: solo queda añadir la clave a la autorización.Crea un cliente para tu lenguaje
Vale cualquier generador que entienda OpenAPI 3.1. Por ejemplo, los tipos para TypeScript:
npx openapi-typescript openapi.json -o rendergrid.d.tsCliente para Python (requiere Java):
npx @openapitools/openapi-generator-cli generate \ -i openapi.json -g python -o ./rendergrid-clientComprueba la respuesta con una solicitud real
El archivo describe campos y códigos, pero no sustituye a una comprobación. Envía una solicitud del inicio rápido y compara la respuesta con la descripción.
Al cliente generado le faltan los reintentos y la espera. Añade tú mismo los reintentos ante 429, la clave X-Idempotency-Key y el sondeo de la tarea: Límites, Reintentos sin doble cargo.
Autorización
El archivo describe dos esquemas, y los dos aceptan la misma clave:
| Esquema | Encabezado | Ejemplo |
|---|---|---|
| Bearer | Authorization | Authorization: Bearer rg_live_… |
| Clave en un encabezado | X-API-Key | X-API-Key: rg_live_… |
Dónde conseguir la clave y cómo protegerla: en la sección «Claves y acceso».
Versión y cambios
La versión de la API forma parte de la dirección: /api/. Dentro de una versión, las respuestas pueden incorporar campos nuevos y códigos de error nuevos, así que procesa la respuesta con tolerancia: ignora los campos desconocidos y trata un código desconocido según su tipo.
Qué ha cambiado y cuándo: en la página «Novedades».