API de Clipia · v1

API para desarrolladores

Genere imágenes y vídeo mediante la API: cola asíncrona, webhooks firmados, SDK de TypeScript y Python, una CLI y facturación basada en créditos. Los mismos modelos que en la aplicación.

API de cola
submit → poll / webhook
TS · Python · CLI
SDK oficiales
Imágenes y vídeo
un único punto de entrada
Capacidades

Lo que le ofrece la API

Una integración lista para producción en cinco minutos, sin sorpresas en producción.

API de cola

Una cola asíncrona: submit encola un trabajo y devuelve un request_id al instante. Obtenga el resultado consultando status_url o de inmediato mediante un webhook.

SDK y CLI

Clientes oficiales para TypeScript y Python con un subscribe de alto nivel, además de una CLI para scripts y comprobaciones rápidas.

Sandbox

Una clave clipia_test_ devuelve un resultado fijo al instante: depure el análisis de respuestas, el polling y los webhooks sin gastar créditos.

Webhooks firmados

Al finalizar, Clipia envía un POST firmado con HMAC-SHA256. Verifique la firma con el cuerpo sin procesar; los SDK incluyen una utilidad lista para usar.

Idempotencia

El encabezado Idempotency-Key hace seguros los reintentos: la misma clave devuelve el mismo request_id, sin trabajos duplicados ni doble cobro.

Límites transparentes

Límites por clave: solicitudes por minuto y generaciones simultáneas. El estado actual aparece en los encabezados RateLimit-* de cada respuesta.

Inicio rápido

Inicio rápido en 5 minutos

Un trabajo de texto a imagen, de tres maneras. Primero guarde su clave en una variable de entorno.

Guarde su clave en la variable de entorno CLIPIA_KEY
export CLIPIA_KEY="clipia_live_xxxxxxxxxxxxxxxxxxxxxx"
# Submit a text-to-image job
curl -X POST https://api.clipia.ai/v1/models/nano-banana-2 \
  -H "Authorization: Key $CLIPIA_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{ "input": { "prompt": "a sunset over mountains, cinematic" } }'

# Poll the request until status == COMPLETED, then read the result
curl https://api.clipia.ai/v1/requests/<request_id> \
  -H "Authorization: Key $CLIPIA_KEY"

Los SDK generan por defecto una Idempotency-Key (UUID v4) en cada submit, por lo que los reintentos son seguros desde el primer momento.

Instalación

Instale el SDK

El subscribe de alto nivel encola el trabajo y consulta el estado hasta que el resultado esté listo.

TypeScript
npm i clipia-ai
Python
pip install clipia
CLI
npx clipia account

Los nombres de los paquetes son definitivos; la publicación en npm y PyPI forma parte del lanzamiento.

Autenticación

Autenticación

Envíe su clave de API en el encabezado Authorization con el esquema Key.

Encabezado de la solicitud
Authorization: Key clipia_live_xxxxxxxxxxxxxxxxxxxxxx
La clave es un secreto del lado del servidor

Equivale a la contraseña de su saldo de créditos. Haga las llamadas solo desde su propio servidor y guarde la clave en una variable de entorno o en un gestor de secretos. Nunca la ponga en un navegador, una aplicación móvil ni un repositorio público.

Una clave activa se muestra una sola vez al crearla. Después, la lista muestra solo el prefijo.

Errores

Gestión de errores

Todos los errores llegan con un único formato JSON. Los SDK lanzan un error tipado con .status y .code.

HTTPCódigoCuándoReintento
400invalid_requestCuerpo o parámetros no válidosNo reintentar
401invalid_api_keyClave ausente, no válida o revocadaNo reintentar
402insufficient_creditsNo hay suficientes créditos en el saldoNo reintentar
402subscription_requiredTiene créditos, pero están bloqueados: se requiere una suscripción activaNo reintentar
403insufficient_scopeLa clave no tiene el alcance necesarioNo reintentar
404not_foundrequest_id o modelo desconocidoNo reintentar
409idempotency_key_reuseConflicto de idempotenciaNo reintentar
422model_input_invalidLos parámetros no coinciden con el modeloNo reintentar
429rate_limit_exceededSe superó el límite de solicitudesCon backoff
5xxinternal_errorError interno o indisponibilidad temporalCon backoff
Webhooks

Webhooks en lugar de polling

En producción, pase webhook_url al enviar: Clipia entrega el resultado en cuanto está listo.

Verificación de la firma

Cada entrega se firma con HMAC-SHA256 en el encabezado X-Clipia-Signature. Verifique la firma con el cuerpo sin procesar de la solicitud antes de analizar el JSON; los SDK incluyen una utilidad de verificación.

Entrega y reintentos

Responda con 2xx en un plazo de 10 segundos. Si falla, las entregas se reintentan con backoff exponencial. Un mismo evento puede llegar de nuevo, así que procese los webhooks de forma idempotente por request_id.

MCP

MCP para Claude Code y agentes de IA

Clipia MCP le permite generar imágenes y vídeo directamente desde Claude Code, Cursor y cualquier otro cliente MCP. Endpoint: https://mcp.clipia.ai/mcp, con autorización mediante clave de API. Guía completa para cada agente: claude.ai, ChatGPT, Cursor y más

Endpoint de MCP
https://mcp.clipia.ai/mcp
Claude Code
claude mcp add --transport http clipia https://mcp.clipia.ai/mcp --header "Authorization: Bearer YOUR_KEY"
Cursor (mcp.json)
{
  "mcpServers": {
    "clipia": {
      "url": "https://mcp.clipia.ai/mcp",
      "headers": { "Authorization": "Bearer YOUR_KEY" }
    }
  }
}
Herramientas
HerramientaQué hace
generate_imageEnvía un trabajo de generación de imágenes
generate_videoEnvía un trabajo de generación de vídeo
generate_audioEnvía un trabajo de generación de texto a voz
generate_musicEnvía un trabajo de generación de música
wait_generationEspera hasta que finalice una generación
get_generationEstado y resultado de una generación por ID
list_modelsLista los modelos disponibles y sus precios en créditos
get_modelParámetros y precio de un modelo concreto
get_balanceSaldo actual de créditos
search_templatesBusca en la biblioteca de plantillas de prompts

Las claves con el prefijo clipia_test_ se ejecutan en el sandbox: respuestas simuladas al instante, sin cobro de créditos.

Cree su clave en la consola para desarrolladores, pestaña Claves de API.

Siguiente

¿Listo para integrar? Obtenga una clave. ¿Necesita detalles del contrato? Descargue la especificación completa.