API-referens

Använd dessa REST-slutpunkter från Prompt Converter Cloud. Autentisera med en Cloud API-nyckel efter prenumeration.

Autentisering

Skicka Authorization: Bearer pc_cloud_… eller rubriken X-Api-Key. Skapa nycklar på sidan API-nycklar efter en aktiv Cloud-prenumeration. Skicka inte en Supabase-JWT.

Bas-URL

I produktion används din Cloud-värd, till exempel https://api.yourdomain.com. Lokalt: http://localhost:5000.

Fel

Misslyckade begäranden returnerar ett JSON-objekt med en maskinläsbar felkod och ett valfritt meddelande.

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

Konvertera en prompt

POST /v1/convert

Konverterar råtext till en optimerad prompt för den valda modellen. Tillgängligt på alla Cloud-planer och räknas mot den månatliga konverteringskvoten.

Tillgänglig på: Alla Cloud-planer

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.
Content-Type string obligatorisk: Måste vara application/json för JSON-kroppar.

Kroppsparametrar

rawInput string obligatorisk: Texten som ska konverteras eller skickas som chattur.
targetModel string valfri: Routningsnyckel: gpt, claude, gemini eller grok. Standard är gpt.
openAiResultModel string valfri: Valfritt OpenAI-modell-id från GET /v1/models när targetModel är gpt.
claudeResultModel string valfri: Valfritt Anthropic-modell-id från GET /v1/models när targetModel är claude.
geminiResultModel string valfri: Valfritt Gemini-modell-id från GET /v1/models när targetModel är gemini.
grokResultModel string valfri: Valfritt xAI Grok-modell-id från GET /v1/models när targetModel är grok.

Exempelbegäran

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

Lyckat svar

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

Fel

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

Skapa en chattkomplettering

POST /v1/chat

Kör en enkel chattur med samma modellfält som convert. Endast Growth och Business. Räknas mot konverteringskvoten.

Tillgänglig på: Growth och Business

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.
Content-Type string obligatorisk: Måste vara application/json för JSON-kroppar.

Kroppsparametrar

rawInput string obligatorisk: Texten som ska konverteras eller skickas som chattur.
targetModel string valfri: Routningsnyckel: gpt, claude, gemini eller grok. Standard är gpt.
openAiResultModel string valfri: Valfritt OpenAI-modell-id från GET /v1/models när targetModel är gpt.
claudeResultModel string valfri: Valfritt Anthropic-modell-id från GET /v1/models när targetModel är claude.
geminiResultModel string valfri: Valfritt Gemini-modell-id från GET /v1/models när targetModel är gemini.
grokResultModel string valfri: Valfritt xAI Grok-modell-id från GET /v1/models när targetModel är grok.

Exempelbegäran

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

Lyckat svar

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

Fel

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

Lista modeller

GET /v1/models

Returnerar chatt-, bild- och videomodeller med korta beskrivningar. Använd id som *ResultModel eller modelId.

Tillgänglig på: Growth och Business

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.

Frågeparametrar

kind string valfri: Valfritt filter: chat, image eller video.

Exempelbegäran

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

Lyckat svar

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

Fel

401 missing_authorization / invalid_api_key, 403 plan_required, 502 internal_error

Generera bilder

POST /v1/images

Genererar bilder synkront och returnerar signerade URL:er. Growth: 80 bilder per period; Business: 300.

Tillgänglig på: Growth och Business

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.
Content-Type string obligatorisk: Måste vara application/json för JSON-kroppar.

Kroppsparametrar

prompt string obligatorisk: Genereringsprompt. Får inte vara tom.
modelId string obligatorisk: Modell-id från GET /v1/models för matchande typ.
aspectRatio string valfri: Valfritt bildförhållande, till exempel 1:1, 16:9, 9:16 eller 4:3.
count integer valfri: Valfritt antal bilder (1–4) när modellen tillåter det.
quality string valfri: Valfri OpenAI-bildkvalitet: standard eller high.

Exempelbegäran

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

Lyckat svar

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

Fel

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

Generera en video

POST /v1/videos

Startar ett videojobb och returnerar HTTP 202 med jobId. Poll GET /v1/videos/{jobId}. Growth: 20 videor; Business: 50.

Tillgänglig på: Growth och Business

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.
Content-Type string obligatorisk: Måste vara application/json för JSON-kroppar.

Kroppsparametrar

prompt string obligatorisk: Genereringsprompt. Får inte vara tom.
modelId string obligatorisk: Modell-id från GET /v1/models för matchande typ.
aspectRatio string valfri: Valfritt bildförhållande, till exempel 1:1, 16:9, 9:16 eller 4:3.
durationSeconds integer valfri: Valfri videolängd i sekunder (vanligtvis 4 eller 8).

Exempelbegäran

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

Lyckat svar

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

Fel

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

Poll ett videojobb

GET /v1/videos/{jobId}

Returnerar status för ett videojobb som tillhör API-nyckelns användare. Slutförda jobb innehåller signerade URL:er.

Tillgänglig på: Growth och Business

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.

Sökvägsparametrar

jobId uuid obligatorisk: Jobb-id som returneras av POST /v1/videos.

Exempelbegäran

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

Lyckat svar

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

Fel

400 job_id_required, 401 missing_authorization, 403 plan_required, 404 job_not_found

Hämta användning

GET /v1/usage

Returnerar konverterings- och medieanvändning för den aktuella Cloud-perioden, inklusive gränser.

Tillgänglig på: Alla Cloud-planer

Rubriker

Authorization string valfri: Cloud API-nyckel Bearer pc_cloud_…. Obligatorisk om X-Api-Key inte skickas.
X-Api-Key string valfri: Cloud API-nyckel pc_cloud_…. Alternativ till Authorization.

Exempelbegäran

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

Lyckat svar

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

Fel

401 missing_authorization / invalid_api_key, 502 internal_error

Hälsokontroll

GET /v1/health

Liveness-kontroll. Kräver ingen API-nyckel.

Tillgänglig på: Publik (ingen API-nyckel)

Exempelbegäran

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

Lyckat svar

{ "status": "ok" }

Fel

—