> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Anuluj akcję segmentu w kolejce > Anuluj własną oczekującą akcję segmentu. Nie można anulować akcji, która jest już wykonywana. Anuluj własną oczekującą akcję segmentu. Nie można anulować akcji, która jest już wykonywana. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel ``` ## Uwierzytelnianie i uprawnienia Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są akceptowane tylko przez MCP, a nie przez ten endpoint REST. Wymagane uprawnienia: `translations:write`. Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu. ## Parametry Wartość tekstowa. Minimalna długość: 1. Maksymalna długość: 200. Wzorzec: `^[^/\\]+$`. Wartość tekstowa. Format: "uuid". Wzorzec: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`. Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi. Format: "uuid". Wzorzec: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`. Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji. ```json theme={null} { "type": "object", "properties": { "projectId": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^/\\\\]+$" }, "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "requestId": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries." } }, "required": ["projectId", "jobId"], "additionalProperties": false } ``` ## Idempotencja Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie. Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny. ## Przykłady żądań Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}' ``` ```javascript JavaScript theme={null} const input = { projectId: 'project_launch_2026', jobId: '41321bda-e243-4b6f-96a4-622cd047c991', requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', { method: 'POST', headers: { 'x-api-key': process.env.VOICECHEAP_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify(input), }); const body = await response.json(); if (!response.ok) throw new Error(body.code + ': ' + body.message); console.log(body); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/segment_actions_cancel", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## Odpowiedź Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Zwraca pełny zaktualizowany stan kolejki po anulowaniu akcji, która nadal oczekuje w kolejce. ```json HTTP 200 theme={null} { "data": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ## Pola wyniku | Pole | Opis | | - | - | | `data.projectId` | Identyfikator projektu nadrzędnego. | | `data.revision` | Rewizja migawki kolejki. Jest niezależna od projects\_get.segmentStructureRevision. | | `data.items` | Postęp działań projektu: identyfikatory zadań, metadane działań, stan, znaczniki czasu i opcjonalny publiczny errorCode. | | `data.items[].id` | Identyfikator zadania; jest równy requestId pierwotnego zgłoszenia do kolejki. | | `data.items[].action` | Tylko metadane działania: type, segmentIndex oraz opcjonalnie workId, translatedVersionId i source. Przesłany tekst, wartości czasu i instrukcje ponownego generowania nie są zwracane. | | `data.items[].status` | queued, running, completed, failed lub cancelled. | | `data.items[].createdAt` | Czas utworzenia elementu kolejki w milisekundach czasu Unix. | | `data.items[].startedAt` | Opcjonalny czas pierwszego uruchomienia w milisekundach Unix. | | `data.items[].finishedAt` | Opcjonalny czas osiągnięcia stanu końcowego w milisekundach Unix. | | `data.items[].errorCode` | Opcjonalny publiczny kod błędu. Niesklasyfikowane błędy używają ACTION\_FAILED. | | `data.items[].seenAt` | Opcjonalny czas potwierdzenia wyłącznie dla uwierzytelnionego odbiorcy. | ## Odzyskaj żądanie i sprawdź jego stan Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp. ```bash theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020","operation":"segment_actions_cancel"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] } } } ``` ## Uwagi do operacji * jobId identyfikuje element kolejki do anulowania; requestId to odrębny, stały UUID v4 żądania anulowania. * Tylko element w stanie queued może przejść do cancelled. Nie można anulować elementów w stanie running, completed i failed. Anulowanie już anulowanego elementu zwraca bieżący obraz stanu. * Procedura obsługi zwraca bezpośrednio projectId, revision i items; nie ma wartości logicznej success ani zagnieżdżonego pola queue. * Anulowanie nie zwraca kosztu ukończonego generowania ani nie zatrzymuje już trwającego przetwarzania multimediów. * Odpowiedzi kolejki, również przy przesyłaniu, anulowaniu, odpytywaniu i ponawianiu, zawierają tylko metadane działań. Odczytuj treść transkrypcji przez transcripts\_get z wymaganym uprawnieniem transcription:read. ## Wykorzystanie Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji. ## Błędy | Status HTTP | Kod | Znaczenie lub sposób rozwiązania | | - | - | - | | 400 | `CREDENTIAL_IN_QUERY` | Dane uwierzytelniające zostały podane w parametrze zapytania access\_token lub api\_key. Wysyłaj dane uwierzytelniające w nagłówkach. | | 400 | `IDEMPOTENCY_CONFLICT` | Nagłówek Idempotency-Key i pole requestId w treści żądania muszą być zgodne. | | 400 | `INVALID_REQUEST_ID` | Podaj requestId lub Idempotency-Key w formacie UUID v4. | | 400 | `VALIDATION_ERROR` | Popraw dane wejściowe zgodnie ze schematem. Nieprawidłowe lub niespójne wartości są odrzucane przed wykonaniem. | | 401 | `API_KEY_EXPIRED` | Klucz API wygasł. | | 401 | `INVALID_API_KEY` | Podaj prawidłowy, niewygasły klucz API. | | 401 | `INVALID_CREDENTIAL` | Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key. | | 401 | `MISSING_CREDENTIAL` | Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków. | | 401 | `USER_NOT_FOUND` | Konto powiązane z poświadczeniem już nie istnieje. | | 403 | `ACCOUNT_UNAVAILABLE` | Konto wykonujące operację lub konto rozliczeniowe jest niedostępne albo jest w trakcie usuwania. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny. | | 403 | `FORBIDDEN` | Uwierzytelniony podmiot wykonujący akcję nie ma dostępu do tego projektu. | | 403 | `INSUFFICIENT_SCOPE` | Nadaj wszystkie wymagane uprawnienia lub wybierz inne dane uwierzytelniające. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Nie udało się zweryfikować limitów integracji konta. | | 403 | `SUBSCRIPTION_REQUIRED` | Użyj aktywnej płatnej subskrypcji. | | 403 | `TEAM_OWNER_NOT_FOUND` | Nie znaleziono konta faktycznego właściciela zespołu. | | 404 | `NOT_FOUND` | W projekcie nie ma elementu kolejki z tym jobId. | | 404 | `PROJECT_NOT_FOUND` | Projekt nie istnieje na dostępnym koncie. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Na tym koncie działa już 10 akcji integracji. Sprawdzaj stan istniejącego żądania przed rozpoczęciem kolejnego. | | 409 | `CONFLICT` | Można anulować tylko akcje oczekujące; ten element już się rozpoczął lub zakończył. | | 409 | `IDEMPOTENCY_CONFLICT` | Używaj ponownie identyfikatora wyłącznie z tą samą operacją i tymi samymi argumentami. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Poczekaj na odnowienie miesięcznego limitu lub zmień plan. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Jeśli występuje nagłówek Retry-After, odczekaj wskazany czas i stosuj rosnące odstępy między ponowieniami. | | 500 | `INTERNAL_ERROR` | Sprawdź stan zapisanego żądania i historię zasobu przed podjęciem decyzji o ponowieniu operacji zmieniającej dane. | | 503 | `ACTION_RESULT_UNAVAILABLE` | Akcja została wykonana, ale nie udało się zapisać jej wyniku. Sprawdź zapisany stan żądania i historię zasobu przed rozpoczęciem nowego generowania. | | 503 | `SERVER_RESTARTING` | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["translations:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.