> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI de Octoparse

> Referencia de OpenAPI de Octoparse para autenticación, gestión de tareas, extracción en la nube y exportación de datos.

Usa la OpenAPI de Octoparse para gestionar tareas, realizar extracciones en la nube y recuperar mediante programación los datos extraídos.

## Autenticación

Para los endpoints protegidos, el método de autenticación más sencillo es una clave de API de Octoparse. Crea una clave en el centro de cuentas de Octoparse e inclúyela en el encabezado de solicitud `x-api-key`. Puedes usar la misma clave con OpenAPI, el servidor MCP y la CLI de Octoparse.

<Card title="Crear o gestionar claves de API" icon="key" href="https://www.octoparse.es/console/account-center/api-keys">
  Abre la página de claves de API en el centro de cuentas de Octoparse.
</Card>

Las claves de API suelen comenzar por `op_sk_`:

```bash theme={null}
curl "https://openapi.octoparse.com/taskGroup" \
  --header "x-api-key: op_sk_xxxxx"
```

<Warning>
  Mantén en secreto tu clave de API. No la expongas en código del navegador, repositorios públicos, capturas de pantalla ni registros.
</Warning>

También se admite la autenticación mediante tokens de acceso. Obtén uno con `POST /token` y envíalo como `Authorization: Bearer <access_token>`.

## API de AgentTools

La API de AgentTools es una capa de flujos de trabajo basada en plantillas y destinada a agentes de IA que se ejecuta sobre las API heredadas de bajo nivel de tareas, extracción en la nube y datos. Úsala cuando un agente o una automatización necesite descubrir una plantilla adecuada, iniciar una ejecución, seguir las indicaciones del servidor y recuperar los metadatos de exportación sin conectar directamente cada endpoint de bajo nivel.

Nuevo flujo de web scraping:

```text theme={null}
searchTemplates -> executeTask -> exportData
```

Flujo de tareas existentes:

```text theme={null}
searchTasks -> startOrStopTask -> exportData
```

Si es la primera vez que usas AgentTools, consulta el [tutorial completo del flujo de trabajo](https://helpcenter.octoparse.com/es/articles/15855832-run-a-scraping-workflow-with-the-octoparse-agenttools-api) para aprender a buscar plantillas, iniciar una tarea y exportar los resultados.

Las respuestas de AgentTools mantienen los campos empresariales dentro de `data`. Usa `requestId` solo para solucionar problemas y sigue `retryGuidance`, `suggestedNextCall`, `workflow` y `toolHint` en lugar de codificar intervalos de consulta fijos.

<Info>
  La API de AgentTools requiere autenticación mediante `x-api-key`. Algunos endpoints también requieren `x-external-user-id`; consulta la referencia de cada endpoint para conocer los encabezados exactos.
</Info>

## Antes de empezar

Para usar OpenAPI de Octoparse, necesitas una cuenta con el **Plan Estándar, Plan Profesional o Plan Empresarial** y al menos una tarea que funcione. [Regístrate aquí](https://www.octoparse.es/signup) si todavía no tienes una cuenta.

Versión actual de la API: **v1.0**

## URL base

Todas las solicitudes deben codificarse como URL con respecto a la URL base:

```text theme={null}
https://openapi.octoparse.com
```

Los marcadores de posición se muestran como `{xxxx}` y deben sustituirse por valores reales. Por ejemplo, la URL de solicitud de *Buscar tarea* es:

```text theme={null}
GET https://openapi.octoparse.com/task/search?taskGroupId={taskGroupId}
```

Si el ID del grupo de tareas es `abc`, la URL pasa a ser `https://openapi.octoparse.com/task/search?taskGroupId=abc`.

## Límites de solicitudes

Octoparse limita el uso de la API a **20 solicitudes por segundo**. Si recibes el código de estado `429`, reduce la frecuencia de las solicitudes.

Una respuesta correcta devuelve HTTP `200`. Para otros códigos, consulta la sección [Referencias](#) de cada endpoint.

## Permisos

Asegúrate de que tu cuenta tenga permiso para utilizar cada servicio. Si no lo tiene, actualiza el plan.

| Servicio              | API                                                  | Plan requerido                     |
| --------------------- | ---------------------------------------------------- | ---------------------------------- |
| Token de acceso       | Obtener un token nuevo                               | Todos los usuarios                 |
| Token de acceso       | Actualizar token                                     | Todos los usuarios                 |
| Grupo de tareas       | Obtener información del grupo de tareas              | Estándar, Profesional, Empresarial |
| Tarea                 | Buscar tarea                                         | Estándar, Profesional, Empresarial |
| Tarea                 | Duplicar tarea                                       | Estándar, Profesional, Empresarial |
| Tarea                 | Mover tarea                                          | Estándar, Profesional, Empresarial |
| Tarea                 | Obtener parámetros de acción                         | Profesional, Empresarial           |
| Tarea                 | Actualizar parámetros de la tarea                    | Profesional, Empresarial           |
| Tarea                 | Actualizar parámetros de acción                      | Profesional, Empresarial           |
| Tarea                 | Actualizar la lista de elementos de bucle            | Profesional, Empresarial           |
| Tarea                 | Actualizar las URL de la tarea                       | Profesional, Empresarial           |
| Extracción en la nube | Iniciar tarea                                        | Profesional, Empresarial           |
| Extracción en la nube | Detener tarea                                        | Profesional, Empresarial           |
| Extracción en la nube | Obtener el estado de la tarea                        | Profesional, Empresarial           |
| Extracción en la nube | Obtener el estado de la tarea V2                     | Profesional, Empresarial           |
| Extracción en la nube | Obtener el estado de la subtarea                     | Profesional, Empresarial           |
| Extracción en la nube | Iniciar subtareas                                    | Profesional, Empresarial           |
| Extracción en la nube | Detener subtareas                                    | Profesional, Empresarial           |
| Datos                 | Obtener datos no exportados                          | Estándar, Profesional, Empresarial |
| Datos                 | Marcar los datos como exportados                     | Estándar, Profesional, Empresarial |
| Datos                 | Obtener datos por desplazamiento                     | Estándar, Profesional, Empresarial |
| Datos                 | Obtener datos de un lote concreto por desplazamiento | Estándar, Profesional, Empresarial |
| Datos                 | Eliminar datos                                       | Estándar, Profesional, Empresarial |

## Solución de problemas

Todas las respuestas incluyen un `requestId`. Si falla una solicitud, comparte el `requestId` con el [equipo de soporte de Octoparse](mailto:support@octoparse.com) para facilitar el diagnóstico.
