Довідка API

Використовуйте ці REST-ендпоінти Prompt Converter Cloud. Автентифікуйтеся хмарним API-ключем після підписки.

Автентифікація

Надішліть Authorization: Bearer pc_cloud_… або заголовок X-Api-Key. Створюйте ключі на сторінці API-ключів після активної хмарної підписки. Не надсилайте JWT Supabase.

Базовий URL

У продакшені використовуйте хост Cloud, наприклад https://api.yourdomain.com. Локально: http://localhost:5000.

Помилки

Невдалі запити повертають JSON-об’єкт із машиночитним кодом помилки та необов’язковим повідомленням.

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

Перетворити промпт

POST /v1/convert

Перетворює вихідний текст на оптимізований промпт для вибраної моделі. Доступно в усіх хмарних планах і враховується в місячній квоті перетворень.

Доступно в: Усі хмарні плани

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.
Content-Type string обов’язково: Для JSON-тіла має бути application/json.

Параметри тіла

rawInput string обов’язково: Текст для перетворення або як хід чату.
targetModel string необов’язково: Ключ маршруту: gpt, claude, gemini або grok. За замовчуванням gpt.
openAiResultModel string необов’язково: Необов’язковий id моделі OpenAI з GET /v1/models, якщо targetModel — gpt.
claudeResultModel string необов’язково: Необов’язковий id моделі Anthropic з GET /v1/models, якщо targetModel — claude.
geminiResultModel string необов’язково: Необов’язковий id моделі Gemini з GET /v1/models, якщо targetModel — gemini.
grokResultModel string необов’язково: Необов’язковий id моделі xAI Grok з GET /v1/models, якщо targetModel — grok.

Приклад запиту

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"}'

Успішна відповідь

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

Помилки

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

Створити відповідь чату

POST /v1/chat

Виконує одноходовий чат із тими самими полями моделі, що й convert. Лише Growth і Business. Враховується в квоті перетворень.

Доступно в: Growth і Business

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.
Content-Type string обов’язково: Для JSON-тіла має бути application/json.

Параметри тіла

rawInput string обов’язково: Текст для перетворення або як хід чату.
targetModel string необов’язково: Ключ маршруту: gpt, claude, gemini або grok. За замовчуванням gpt.
openAiResultModel string необов’язково: Необов’язковий id моделі OpenAI з GET /v1/models, якщо targetModel — gpt.
claudeResultModel string необов’язково: Необов’язковий id моделі Anthropic з GET /v1/models, якщо targetModel — claude.
geminiResultModel string необов’язково: Необов’язковий id моделі Gemini з GET /v1/models, якщо targetModel — gemini.
grokResultModel string необов’язково: Необов’язковий id моделі xAI Grok з GET /v1/models, якщо targetModel — grok.

Приклад запиту

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"}'

Успішна відповідь

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

Помилки

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

Список моделей

GET /v1/models

Повертає моделі чату, зображень і відео з короткими описами. Використовуйте id як *ResultModel або modelId.

Доступно в: Growth і Business

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.

Параметри запиту

kind string необов’язково: Необов’язковий фільтр: chat, image або video.

Приклад запиту

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

Успішна відповідь

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

Помилки

401 missing_authorization / invalid_api_key, 403 plan_required, 502 internal_error

Згенерувати зображення

POST /v1/images

Синхронно генерує зображення та повертає підписані URL. Growth: 80 зображень за період; Business: 300.

Доступно в: Growth і Business

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.
Content-Type string обов’язково: Для JSON-тіла має бути application/json.

Параметри тіла

prompt string обов’язково: Промпт генерації. Не може бути порожнім.
modelId string обов’язково: Id моделі з GET /v1/models для відповідного типу.
aspectRatio string необов’язково: Необов’язкове співвідношення сторін, наприклад 1:1, 16:9, 9:16 або 4:3.
count integer необов’язково: Необов’язкова кількість зображень (1–4), якщо модель це дозволяє.
quality string необов’язково: Необов’язкова якість зображення OpenAI: standard або high.

Приклад запиту

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"}'

Успішна відповідь

{
  "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"
    }
  ]
}

Помилки

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

Згенерувати відео

POST /v1/videos

Запускає завдання відео й повертає HTTP 202 з jobId. Опитуйте GET /v1/videos/{jobId}. Growth: 20 відео; Business: 50.

Доступно в: Growth і Business

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.
Content-Type string обов’язково: Для JSON-тіла має бути application/json.

Параметри тіла

prompt string обов’язково: Промпт генерації. Не може бути порожнім.
modelId string обов’язково: Id моделі з GET /v1/models для відповідного типу.
aspectRatio string необов’язково: Необов’язкове співвідношення сторін, наприклад 1:1, 16:9, 9:16 або 4:3.
durationSeconds integer необов’язково: Необов’язкова тривалість відео в секундах (зазвичай 4 або 8).

Приклад запиту

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}'

Успішна відповідь

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

Помилки

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

Опитати завдання відео

GET /v1/videos/{jobId}

Повертає статус відеозавдання власника ключа. Завершені завдання містять підписані URL.

Доступно в: Growth і Business

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.

Параметри шляху

jobId uuid обов’язково: Id завдання, повернутий POST /v1/videos.

Приклад запиту

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

Успішна відповідь

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

Помилки

400 job_id_required, 401 missing_authorization, 403 plan_required, 404 job_not_found

Отримати використання

GET /v1/usage

Повертає використання перетворень і медіа за поточний хмарний період, включно з лімітами.

Доступно в: Усі хмарні плани

Заголовки

Authorization string необов’язково: Хмарний API-ключ Bearer pc_cloud_…. Обов’язковий, якщо не надіслано X-Api-Key.
X-Api-Key string необов’язково: Хмарний API-ключ pc_cloud_…. Альтернатива Authorization.

Приклад запиту

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

Успішна відповідь

{
  "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
}

Помилки

401 missing_authorization / invalid_api_key, 502 internal_error

Перевірка стану

GET /v1/health

Перевірка доступності. API-ключ не потрібен.

Доступно в: Публічно (без API-ключа)

Приклад запиту

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

Успішна відповідь

{ "status": "ok" }

Помилки

—