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

# Referencia de la API

> Referencia completa para la API REST de VoiceCheap

# Referencia de la API

La API de VoiceCheap está organizada en torno a principios REST. Utiliza métodos HTTP estándar, devuelve respuestas codificadas en JSON y utiliza códigos de respuesta HTTP estándar.

## URL base

Todas las solicitudes a la API deben realizarse a:

```
https://api.voicecheap.ai
```

## Autenticación

Todas las solicitudes requieren una clave de API enviada en el encabezado `x-api-key`. Consulte la página [Autenticación](/docs/es/authentication) para obtener más detalles.

## Tipos de contenido

* **Solicitud**: Utilice `multipart/form-data` para cargas de archivos, `application/json` para otras solicitudes
* **Respuesta**: Los puntos finales JSON devuelven `application/json`. Las exportaciones de transcripciones también pueden devolver texto SRT o VTT.

## Puntos finales disponibles

<CardGroup cols={2}>
  <Card title="Transcribir medio" icon="captions" href="/docs/es/api-reference/transcribe">
    `POST /v1/transcribe`

    Transcriba un archivo cargado como JSON, SRT o VTT.
  </Card>

  <Card title="Exportar transcripción del proyecto" icon="file-lines" href="/docs/es/api-reference/project-transcript">
    `POST /v1/projects/{projectId}/transcript`

    Recupere transcripciones de proyectos originales o traducidas.
  </Card>

  <Card title="Iniciar traducción" icon="play" href="/docs/es/api-reference/translate">
    `POST /v1/translate`

    Cargue un archivo de video o audio e inicie un proyecto de traducción.
  </Card>

  <Card title="Obtener estado de la traducción" icon="magnifying-glass" href="/docs/es/api-reference/translation-status">
    `GET /v1/translate/{projectId}/status`

    Verifique el estado de un proyecto de traducción y recupere los resultados.
  </Card>

  <Card title="Obtener detalles del proyecto" icon="list-tree" href="/docs/es/api-reference/project-details">
    `GET /v1/projects/{projectId}`

    Recupere el historial de versiones traducidas, el historial de sincronización labial y el estado del proyecto.
  </Card>

  <Card title="Eliminar proyecto" icon="trash" href="/docs/es/api-reference/delete-project">
    `DELETE /v1/translate/{projectId}`

    Elimine permanentemente un proyecto de traducción y sus activos.
  </Card>
</CardGroup>

## Flujo de trabajo de traducción

El flujo de trabajo típico para traducir un video es:

```mermaid theme={null}
sequenceDiagram
    participant Client
    participant API
    participant Processing

    Client->>API: POST /v1/translate (file + options)
    API->>Processing: Queue translation job
    API-->>Client: 200 OK (projectId)

    loop Poll for status
        Client->>API: GET /v1/translate/{projectId}/status
        API-->>Client: Status (processing/success/failed)
    end

    Note over Client: Download translated video URL when status is "success"
```

## Formato de respuesta

Todas las respuestas exitosas siguen esta estructura general:

```json theme={null}
{
  "success": true,
  "message": "Description of the result"
  // Additional fields specific to the endpoint
}
```

Las respuestas de error siguen esta estructura:

```json theme={null}
{
  "code": "ERROR_CODE",
  "message": "Human-readable error description"
}
```

## Códigos de estado HTTP

| Código de estado | Descripción                                       |
| ---------------- | ------------------------------------------------- |
| 200              | Éxito                                             |
| 400              | Solicitud incorrecta - Parámetros no válidos      |
| 401              | No autorizado - Clave de API no válida o faltante |
| 403              | Prohibido - Permisos o créditos insuficientes     |
| 404              | No encontrado - El recurso no existe              |
| 429              | Demasiadas solicitudes - Límite de tasa excedido  |
| 500              | Error interno del servidor                        |