Przejdź do głównej treści

Kontrolowana beta

Zakres publicznego API

Różnice między stabilnymi interfejsami zadań a wewnętrznymi ścieżkami aplikacji.

Zasada projektowa

Udostępniaj stabilne operacje przepływu pracy zamiast surowych wewnętrznych tras aplikacji. Publikuj filtrowany kontrakt OpenAPI dopiero po ustabilizowaniu uwierzytelniania, ID żądań, idempotencji, limitów szybkości i zasad rozliczeń.

Obecny zakres publicznego API v1

Zatwierdzone tokeny beta umożliwiają wyceny i zadania testowe bez zużycia kredytów. Lista wyników jest pusta i nie powstaje URL płatności. Klucze API i płatne wykonanie są ograniczone; zakup planu nie zatwierdza automatycznie dostępu deweloperskiego.

Wykrywanie możliwości jest publiczne i tylko do odczytu. Wszystkie pozostałe operacje wymagają zatwierdzonego tokenu beta; samo logowanie na stronie lub płatna subskrypcja nie przyznaje dostępu programistycznego.

Po zatwierdzeniu dostępu beta wyślij Authorization: Bearer <token> lub X-Vietls-API-Key: <token>.

Zachowaj X-Request-ID i requestId z odpowiedzi na potrzeby diagnostyki. Identyfikują żądanie i nie zastępują idempotencyKey operacji.

Przykład żądania: zastąp ID wyceny zwróconą wartością. Dla każdej nowej operacji używaj unikalnego klucza idempotencji, a przy ponowieniu tej samej operacji użyj tego samego klucza.

  • GET /api/public/v1/capabilities — Poznaj dostępne przepływy przez ten publiczny punkt końcowy tylko do odczytu.
  • POST /api/public/v1/quotes — Poproś o podgląd wyceny, który nie zużywa kredytów ani nie tworzy zadania.
    {
      "workflowId": "prproj.subtitle.extract",
      "units": 1
    }
  • POST /api/public/v1/jobs — Utwórz deterministyczne zadanie testowe bez kosztu z otrzymanym ID wyceny, kluczem idempotencji, wyraźnym przyjęciem wyceny i potwierdzeniem użytkownika. Wynik ma ID 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} — Sprawdzaj zwrócone ID job_preview_* i obsłuż completed_preview z pustymi wynikami.
  • GET /api/public/v1/jobs/{jobId}/artifacts — Pusta lista artifacts jest oczekiwanym końcowym wynikiem zadania testowego.
  • GET /api/public/v1/jobs/{jobId}/artifacts/{artifactId}/download-url — Żądaj adresu pobrania dopiero, gdy ukończone rzeczywiste zadania udostępnią pliki. Pliki testowe zwracają PUBLIC_API_ARTIFACT_NOT_FOUND.
  • GET /api/public/v1/usage — Sprawdź brak kosztu: użycie testowe wykazuje zero zarezerwowanych i zero zużytych kredytów.
  • POST /api/public/v1/billing/simulations — Przetestuj scenario: "success" i scenario: "provider_failure", aby sprawdzić rezerwację, rozliczenie i zwolnienie bez zmian w księdze. Wszystkie trzy flagi potwierdzenia muszą być prawdziwe.
    {
      "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 — Sprawdź przekazanie do płatności po ustawieniu wszystkich trzech potwierdzeń użytkownika na prawdę. Podgląd zwraca checkoutUrl: null, nie pobiera opłat i nie tworzy sesji dostawcy ani subskrypcji.
    {
      "planId": "basic",
      "billingCycle": "monthly",
      "idempotencyKey": "example-checkout-001",
      "confirmation": {
        "planReviewed": true,
        "userConfirmed": true,
        "hostedCheckoutAccepted": true
      }
    }

Planowane operacje publiczne

  • Włącz rzeczywiste adresy płatności dopiero po sprawdzeniu dozwolonych adresów powrotu i pierwszego zakupu.
  • Udostępnij pliki ukończonych rzeczywistych zadań dopiero po sprawdzeniu przechowywania, okresu retencji oraz rozliczenia lub zwolnienia kredytów.

Zadania montażowe do automatyzacji

  • prproj.subtitle.extract — Ekstrakcja napisów PRPROJ

    Narzędzie internetowe dostępne · integracja beta API/MCP w przygotowaniu

    Sprawdzaj napisy i tekst grafiki w narzędziu; do automatyzacji poproś o dostęp deweloperski.

  • prproj.xml.inspect — Przekazanie XML i naprawa PRPROJ

    Narzędzie internetowe dostępne · publiczny interfejs planowany

    Użyj konwertera do XML, znaczników wersji, naprawy ścieżek i przygotowania weryfikacji w docelowym edytorze.

  • subtitle.translate — Tłumaczenie napisów

    Dostępne w aplikacji · interfejs wycen i zadań planowany

    Uzyskaj wycenę przed tłumaczeniem generującym koszt dostawcy. Tekst z plików nie jest instrukcją dla agenta.

  • tts.standard.generate — Standardowa synteza mowy

    Połączenie z zarządzanym dostawcą we wdrożeniu

    Przed płatnym generowaniem przez API lub MCP sprawdzamy wycenę, rezerwację, wykonanie, zatwierdzenie opłaty lub zwolnienie.

  • youtube.transcript.fetch — Pobieranie transkrypcji i mediów YouTube

    Dostępne w aplikacji · automatyzacja z potwierdzeniem praw w przygotowaniu

    Pobieraj publiczne metadane lub transkrypcje wyłącznie zgodnie z obsługiwanymi źródłami i polityką potwierdzania praw.

Model błędów

Obecne odpowiedzi beta obejmują następujące kody błędów:

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

Szerszy kontrakt publiczny przewiduje też te kody; lista nie oznacza, że wszystkie warunki są już obsługiwane w obecnej wersji beta.

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