Idioma: EN DE FR ES DA UK PL SV RU

Referencia de API

Use estos endpoints REST de Prompt Converter Cloud. Autentíquese con una clave API de Cloud después de suscribirse.

Autenticación

Envíe Authorization: Bearer pc_cloud_… o la cabecera X-Api-Key. Cree claves en la página de claves API tras una suscripción Cloud activa. No envíe un JWT de Supabase.

URL base

En producción use su host Cloud, por ejemplo https://api.yourdomain.com. En local: http://localhost:5000.

Errores

Las solicitudes fallidas devuelven un objeto JSON con un código de error y un mensaje opcional.

{
  "error": "quota_exceeded",
  "message": "Optional human-readable detail"
}

Convertir un prompt

POST /v1/convert

Convierte texto sin formato en un prompt optimizado para el modelo elegido. Disponible en todos los planes Cloud y cuenta para la cuota mensual de conversiones.

Disponible en: Todos los planes Cloud

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.
Content-Type string obligatorio
Debe ser application/json para cuerpos JSON.

Parámetros del cuerpo

rawInput string obligatorio
El texto que se convertirá o se enviará como turno de chat.
targetModel string opcional
Clave de enrutado: gpt, claude, gemini o grok. El valor predeterminado es gpt.
openAiResultModel string opcional
Id de modelo OpenAI opcional de GET /v1/models si targetModel es gpt.
claudeResultModel string opcional
Id de modelo Anthropic opcional de GET /v1/models si targetModel es claude.
geminiResultModel string opcional
Id de modelo Gemini opcional de GET /v1/models si targetModel es gemini.
grokResultModel string opcional
Id de modelo xAI Grok opcional de GET /v1/models si targetModel es grok.

Solicitud de ejemplo

curl -X POST https://api.yourdomain.com/v1/convert \
  -H "Authorization: Bearer pc_cloud_..." \
  -H "Content-Type: application/json" \
  -d '{"rawInput":"Explain dependency injection in .NET","targetModel":"gpt"}'

Respuesta correcta

{
  "result": "You are a senior .NET architect...",
  "targetModel": "gpt",
  "resultModel": "gpt-5.6-luna"
}

Errores

400 raw_input_required, 401 missing_authorization / invalid_api_key, 403 subscription_required, 429 quota_exceeded, 502 provider_failed

Crear una finalización de chat

POST /v1/chat

Ejecuta una finalización de chat de un turno con los mismos campos de modelo que convert. Solo Growth y Business. Cuenta para la cuota de conversiones.

Disponible en: Growth y Business

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.
Content-Type string obligatorio
Debe ser application/json para cuerpos JSON.

Parámetros del cuerpo

rawInput string obligatorio
El texto que se convertirá o se enviará como turno de chat.
targetModel string opcional
Clave de enrutado: gpt, claude, gemini o grok. El valor predeterminado es gpt.
openAiResultModel string opcional
Id de modelo OpenAI opcional de GET /v1/models si targetModel es gpt.
claudeResultModel string opcional
Id de modelo Anthropic opcional de GET /v1/models si targetModel es claude.
geminiResultModel string opcional
Id de modelo Gemini opcional de GET /v1/models si targetModel es gemini.
grokResultModel string opcional
Id de modelo xAI Grok opcional de GET /v1/models si targetModel es grok.

Solicitud de ejemplo

curl -X POST https://api.yourdomain.com/v1/chat \
  -H "Authorization: Bearer pc_cloud_..." \
  -H "Content-Type: application/json" \
  -d '{"rawInput":"Explain dependency injection","targetModel":"gpt","openAiResultModel":"gpt-5.6-luna"}'

Respuesta correcta

{
  "result": "Dependency injection is a technique...",
  "targetModel": "gpt",
  "resultModel": "gpt-5.6-luna"
}

Errores

400 raw_input_required, 401 missing_authorization / invalid_api_key, 403 plan_required, 429 quota_exceeded, 502 provider_failed

Listar modelos

GET /v1/models

Devuelve modelos de chat, imagen y vídeo con descripciones breves. Use id como *ResultModel o modelId.

Disponible en: Growth y Business

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.

Parámetros de consulta

kind string opcional
Filtro opcional: chat, image o video.

Solicitud de ejemplo

curl https://api.yourdomain.com/v1/models?kind=chat \
  -H "Authorization: Bearer pc_cloud_..."

Respuesta correcta

{
  "models": [
    {
      "id": "gpt-5.6-luna",
      "displayName": "GPT-5.6 Luna",
      "provider": "openai",
      "kind": "chat",
      "description": "Chat model",
      "targetModel": "gpt"
    }
  ]
}

Errores

401 missing_authorization / invalid_api_key, 403 plan_required, 502 internal_error

Generar imágenes

POST /v1/images

Genera imágenes de forma síncrona y devuelve URL firmadas. Growth: 80 imágenes por periodo; Business: 300.

Disponible en: Growth y Business

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.
Content-Type string obligatorio
Debe ser application/json para cuerpos JSON.

Parámetros del cuerpo

prompt string obligatorio
Prompt de generación. No puede estar vacío.
modelId string obligatorio
Id de modelo de GET /v1/models para el tipo correspondiente.
aspectRatio string opcional
Relación de aspecto opcional, por ejemplo 1:1, 16:9, 9:16 o 4:3.
count integer opcional
Número opcional de imágenes (1–4) si el modelo lo permite.
quality string opcional
Calidad de imagen OpenAI opcional: standard o high.

Solicitud de ejemplo

curl -X POST https://api.yourdomain.com/v1/images \
  -H "Authorization: Bearer pc_cloud_..." \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A red balloon over a lake at dusk","modelId":"gpt-image-2","aspectRatio":"16:9"}'

Respuesta correcta

{
  "jobId": "11111111-1111-1111-1111-111111111111",
  "status": "completed",
  "kind": "image",
  "modelId": "gpt-image-2",
  "results": [
    {
      "storagePath": "user/job-0.png",
      "signedUrl": "https://...",
      "mimeType": "image/png"
    }
  ]
}

Errores

400 prompt_required / model_not_allowed, 401 missing_authorization, 403 plan_required, 429 quota_exceeded, 502 provider_failed

Generar un vídeo

POST /v1/videos

Inicia un trabajo de vídeo y responde HTTP 202 con jobId. Consulte GET /v1/videos/{jobId}. Growth: 20 vídeos; Business: 50.

Disponible en: Growth y Business

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.
Content-Type string obligatorio
Debe ser application/json para cuerpos JSON.

Parámetros del cuerpo

prompt string obligatorio
Prompt de generación. No puede estar vacío.
modelId string obligatorio
Id de modelo de GET /v1/models para el tipo correspondiente.
aspectRatio string opcional
Relación de aspecto opcional, por ejemplo 1:1, 16:9, 9:16 o 4:3.
durationSeconds integer opcional
Duración de vídeo opcional en segundos (normalmente 4 u 8).

Solicitud de ejemplo

curl -X POST https://api.yourdomain.com/v1/videos \
  -H "Authorization: Bearer pc_cloud_..." \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A red balloon drifting over a lake","modelId":"sora-2","aspectRatio":"16:9","durationSeconds":8}'

Respuesta correcta

{
  "jobId": "22222222-2222-2222-2222-222222222222",
  "status": "processing",
  "kind": "video",
  "modelId": "sora-2"
}

Errores

400 prompt_required / model_not_allowed, 401 missing_authorization, 403 plan_required, 429 quota_exceeded, 502 provider_failed

Consultar un trabajo de vídeo

GET /v1/videos/{jobId}

Devuelve el estado de un trabajo de vídeo del titular de la clave. Los trabajos completados incluyen URL firmadas.

Disponible en: Growth y Business

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.

Parámetros de ruta

jobId uuid obligatorio
Id de trabajo devuelto por POST /v1/videos.

Solicitud de ejemplo

curl https://api.yourdomain.com/v1/videos/22222222-2222-2222-2222-222222222222 \
  -H "Authorization: Bearer pc_cloud_..."

Respuesta correcta

{
  "jobId": "22222222-2222-2222-2222-222222222222",
  "status": "completed",
  "kind": "video",
  "modelId": "sora-2",
  "results": [
    {
      "storagePath": "user/job.mp4",
      "signedUrl": "https://...",
      "mimeType": "video/mp4"
    }
  ]
}

Errores

400 job_id_required, 401 missing_authorization, 403 plan_required, 404 job_not_found

Obtener uso

GET /v1/usage

Devuelve el uso de conversiones y medios del periodo de facturación Cloud actual, incluidas las cuotas.

Disponible en: Todos los planes Cloud

Cabeceras

Authorization string opcional
Clave API Cloud Bearer pc_cloud_…. Obligatoria si no se envía X-Api-Key.
X-Api-Key string opcional
Clave API Cloud pc_cloud_…. Alternativa a Authorization.

Solicitud de ejemplo

curl https://api.yourdomain.com/v1/usage \
  -H "Authorization: Bearer pc_cloud_..."

Respuesta correcta

{
  "used": 42,
  "limit": 5000,
  "planName": "growth",
  "periodStart": "2026-07-01T00:00:00Z",
  "periodEnd": "2026-08-01T00:00:00Z",
  "imagesUsed": 3,
  "imagesLimit": 80,
  "videosUsed": 1,
  "videosLimit": 20
}

Errores

401 missing_authorization / invalid_api_key, 502 internal_error

Comprobación de estado

GET /v1/health

Sonda de disponibilidad. No requiere clave API.

Disponible en: Público (sin clave API)

Solicitud de ejemplo

curl https://api.yourdomain.com/v1/health

Respuesta correcta

{ "status": "ok" }

Errores

—