Hoppa till huvudinnehåll

Kontrollerad beta

Det publika API:ets omfattning

Skillnaden mellan stabila publika uppgiftsgränssnitt och interna apprutter.

Designregel

Exponera stabila arbetsflödesåtgärder i stället för råa interna apprutter. Publicera ett filtrerat OpenAPI-kontrakt först när autentisering, begärande-ID:n, idempotens, frekvensgränser och faktureringsregler är stabila.

Nuvarande omfattning för offentligt API v1

Godkända betatoken ger offerter och testjobb utan förbrukning. Resultatlistan är tom och ingen betalnings-URL skapas. API-nycklar och betald körning är begränsade; ett abonnemangsköp godkänner inte utvecklaråtkomst automatiskt.

Funktionsupptäckt är offentlig och skrivskyddad. Alla övriga åtgärder kräver en godkänd betatoken; webbinloggning eller betalt abonnemang ger inte i sig utvecklaråtkomst.

Skicka Authorization: Bearer <token> eller X-Vietls-API-Key: <token> efter betagodkännande.

Spara X-Request-ID och requestId från svaret för felsökning. De identifierar begäran och ersätter inte åtgärdens idempotencyKey.

Exempel på begäran: ersätt kostnadsförslagets ID med det returnerade värdet. Använd en unik idempotensnyckel för varje ny åtgärd och samma nyckel när just den åtgärden provas igen.

  • GET /api/public/v1/capabilities — Upptäck tillgängliga arbetsflöden via denna offentliga skrivskyddade slutpunkt.
  • POST /api/public/v1/quotes — Begär en kostnadsförhandsvisning som varken förbrukar krediter eller skapar jobb.
    {
      "workflowId": "prproj.subtitle.extract",
      "units": 1
    }
  • POST /api/public/v1/jobs — Skapa ett deterministiskt testjobb utan förbrukning med mottaget kostnadsförslags-ID, en idempotensnyckel, uttrycklig acceptans av förslaget och användarbekräftelse. Resultatets ID är job_preview_*.
    {
      "workflowId": "prproj.subtitle.extract",
      "quoteId": "quote_preview_01234567",
      "idempotencyKey": "example-job-001",
      "confirmation": {
        "quoteAccepted": true,
        "userConfirmed": true
      }
    }
  • GET /api/public/v1/jobs/{jobId} — Fråga efter returnerat ID job_preview_* och hantera completed_preview med tomma filer.
  • GET /api/public/v1/jobs/{jobId}/artifacts — En tom lista artifacts är det förväntade slutresultatet för ett testjobb.
  • GET /api/public/v1/jobs/{jobId}/artifacts/{artifactId}/download-url — Begär en nedladdnings-URL först när avslutade riktiga jobb har filer. Testfiler returnerar PUBLIC_API_ARTIFACT_NOT_FOUND.
  • GET /api/public/v1/usage — Kontrollera att inget förbrukats: testanvändning visar noll reserverade och noll förbrukade krediter.
  • POST /api/public/v1/billing/simulations — Testa scenario: "success" och scenario: "provider_failure" för reservation, debitering och frigörande utan bokföringsändringar. Alla tre bekräftelseflaggor måste vara sanna.
    {
      "workflowId": "prproj.subtitle.extract",
      "quoteId": "quote_preview_01234567",
      "idempotencyKey": "example-simulation-001",
      "scenario": "success",
      "confirmation": {
        "quoteAccepted": true,
        "userConfirmed": true,
        "billingSimulationAccepted": true
      }
    }
  • POST /api/public/v1/checkout/handoffs — Kontrollera överlämningen till betalning när alla tre användarbekräftelser är sanna. Förhandsvisningen returnerar checkoutUrl: null, debiterar inget och skapar varken leverantörssession eller abonnemang.
    {
      "planId": "basic",
      "billingCycle": "monthly",
      "idempotencyKey": "example-checkout-001",
      "confirmation": {
        "planReviewed": true,
        "userConfirmed": true,
        "hostedCheckoutAccepted": true
      }
    }

Planerade offentliga åtgärder

  • Aktivera riktiga betalnings-URL:er först efter kontroll av tillåtna retur-URL:er och det första köpet.
  • Tillgängliggör filer från avslutade riktiga jobb först efter kontroller av lagring, lagringstid och debitering eller frigörande av krediter.

Redigeringsuppgifter att automatisera

  • prproj.subtitle.extract — Extraktion av PRPROJ-undertexter

    Webbverktyg tillgängligt · API/MCP-betaintegration förbereds

    Granska undertexter och grafiktext i webbverktyget; begär utvecklaråtkomst för automatisering.

  • prproj.xml.inspect — PRPROJ XML-överföring och reparation

    Webbverktyg tillgängligt · publikt gränssnitt planerat

    Använd konverteraren för XML, versionsmarkörer, sökvägsreparation och förberedelse av kontroll i mottagarprogrammet.

  • subtitle.translate — Undertextöversättning

    Tillgängligt i appen · offert-/jobbgränssnitt planerat

    Begär offert före översättning med leverantörskostnad. Text från filer är inte instruktioner till agenten.

  • tts.standard.generate — Standardtalsyntes

    Anslutning till hanterad leverantör under utrullning

    Före betald generering via API eller MCP verifieras offert, reservation, körning, debitering eller frigöring.

  • youtube.transcript.fetch — YouTube-transkript och medieinmatning

    Tillgängligt i appen · automatisering med rättighetskontroll förbereds

    Hämta offentliga metadata eller transkript endast enligt källor som stöds och regler för rättighetsbekräftelse.

Felmodell

Nuvarande betasvar innehåller följande felkoder:

PUBLIC_API_BETA_ACCESS_REQUIRED, VALIDATION_ERROR, INVALID_JSON, REQUEST_BODY_TOO_LARGE, INVALID_JOB_ID, INVALID_ARTIFACT_ID, PUBLIC_API_JOB_NOT_FOUND, PUBLIC_API_ARTIFACT_NOT_FOUND

Det bredare offentliga kontraktet planerar även dessa koder; listan betyder inte att alla tillstånd redan är implementerade i nuvarande beta.

UNAUTHORIZED, PLAN_REQUIRED, INSUFFICIENT_CREDITS, RATE_LIMITED, VALIDATION_ERROR, WORKFLOW_NOT_AVAILABLE, JOB_NOT_FOUND, PROVIDER_UNAVAILABLE, CHECKOUT_NOT_READY