> ## 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.

# Segmentacties in de wachtrij ophalen

> Controleer segmentacties voor bewerking of regeneratie van een project die in de wachtrij staan, worden uitgevoerd of zijn voltooid.

Controleer segmentacties voor bewerking of regeneratie van een project die in de wachtrij staan, worden uitgevoerd of zijn voltooid.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/segment_actions_list
```

## Authenticatie en machtigingen

<ParamField header="x-api-key" type="string" required>
  Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
  worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
</ParamField>

Vereiste machtigingen: `projects:read`.

Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

## Parameters

<ParamField body="projectId" type="string" required>
  Tekstwaarde.

  Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
</ParamField>

<Accordion title="Volledig invoerschema">
  Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "projectId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
    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_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden.

Retourneert de huidige revisie van de projectwachtrij en openbare actie-items met de status queued, running of een eindstatus.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "revision": 3,
      "items": [
        {
          "id": "41321bda-e243-4b6f-96a4-622cd047c991",
          "action": {
            "type": "text",
            "segmentIndex": 0,
            "source": "original"
          },
          "status": "completed",
          "createdAt": 1792152000000,
          "startedAt": 1792152001000,
          "finishedAt": 1792152002000
        }
      ]
    }
  }
  ```
</ResponseExample>

## Resultaatvelden

| Veld | Beschrijving |
| - | - |
| `data.projectId` | ID van het bovenliggende project. |
| `data.revision` | Revisie van de wachtrijmomentopname. Deze staat los van projects\_get.segmentStructureRevision. |
| `data.items` | Voortgang van projectacties: taak-ID’s, actiemetagegevens, status, tijdstempels en een optionele openbare errorCode. |
| `data.items[].id` | Taak-ID; gelijk aan de oorspronkelijke requestId waarmee de taak in de wachtrij is geplaatst. |
| `data.items[].action` | Alleen actiemetagegevens: type, segmentIndex en optioneel workId, translatedVersionId en source. Ingediende tekst, tijdwaarden en instructies voor opnieuw genereren worden niet teruggegeven. |
| `data.items[].status` | queued, running, completed, failed of cancelled. |
| `data.items[].createdAt` | Aanmaaktijd van het wachtrij-item in Unix-milliseconden. |
| `data.items[].startedAt` | Optioneel eerste starttijdstip in Unix-milliseconden. |
| `data.items[].finishedAt` | Optioneel tijdstip van de eindstatus in Unix-milliseconden. |
| `data.items[].errorCode` | Optionele openbare foutcode. Niet-geclassificeerde fouten gebruiken ACTION\_FAILED. |
| `data.items[].seenAt` | Optionele bevestigingstijd, uitsluitend voor de aangemelde kijker. |

## Opmerkingen bij de bewerking

* Peil items\[].id die overeenkomen met de jobId die segments\_text\_update, segments\_timestamps\_update of segments\_regenerate retourneert. completed, failed en cancelled zijn eindstatussen.
* revision is de wachtrijrevisie, niet de segmentStructureRevision van de bron die nodig is voor verwijderen of samenvoegen.
* Een actie kan een geslaagde indiening retourneren en later in de wachtrij mislukken. Controleer items\[].errorCode; vernieuw de status van het betrokken project, de transcriptie en de uitvoer voordat je besluit een nieuwe actie uit te voeren.
* Deze bewerking heeft geen pagineringsinvoer. Een project zonder wachtrij retourneert projectId, revision 0 en een lege items-array.
* Wachtrijantwoorden bevatten ook bij indiening, annulering, polling en herhaling alleen actiemetagegevens. Lees transcriptinhoud met transcripts\_get en de vereiste machtiging transcription:read.

## Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

## Fouten

| HTTP-status | Code | Betekenis of herstel |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. |
| 400 | `VALIDATION_ERROR` | Corrigeer de invoer aan de hand van het schema. Ongeldige of tegenstrijdige waarden worden vóór de uitvoering geweigerd. |
| 401 | `API_KEY_EXPIRED` | De API-sleutel is verlopen. |
| 401 | `INVALID_API_KEY` | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | `INVALID_CREDENTIAL` | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | `USER_NOT_FOUND` | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | `FORBIDDEN` | De geauthenticeerde uitvoerende gebruiker heeft geen toegang tot dit project. |
| 403 | `INSUFFICIENT_SCOPE` | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | `PROJECT_NOT_FOUND` | Het project bestaat niet in het toegankelijke account. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["projects:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.