Saltar al contenido principal
POST
/
v1
/
batches
Iniciar un nuevo lote
curl --request POST \
  --url https://api.olostep.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "custom_id": "product-123",
      "url": "https://example.com/product/123",
      "metadata": {
        "source": "catalog_sync",
        "priority": "high"
      }
    },
    {
      "custom_id": "product-456",
      "url": "https://example.com/product/456"
    }
  ],
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
'
{
  "id": "batch_abc123def456",
  "object": "batch",
  "status": "in_progress",
  "created": 1704067200,
  "total_urls": 2,
  "completed_urls": 0,
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
Recibe notificaciones al completar: Pasa el parámetro webhook con la URL de tu endpoint para recibir un HTTP POST cuando el lote se complete. Consulta Webhooks para más detalles.
Adjunta datos personalizados: Usa el parámetro metadata para almacenar pares clave-valor. Se admite en dos niveles:
  • Nivel de lote — en el cuerpo de la solicitud
  • Nivel de elemento — en cada elemento del array items
Consulta Metadata para más detalles.

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Cuerpo

application/json
​
items
object[]
requerido

Array de elementos a procesar en el lote.

​
country
string

País para la ejecución del lote. Proporciona en códigos ISO 3166-1 alfa-2 como US(USA), IN(India), etc.

​
parser
object

Puedes usar este parámetro para especificar el parser a utilizar. Los parsers son útiles para extraer contenido estructurado de páginas web. Olostep tiene algunos parsers integrados para las páginas web más comunes, y también puedes crear tus propios parsers.

​
links_on_page
object

Obtén todos los enlaces presentes en cada página del lote. Los enlaces siempre se devuelven como URLs absolutas.

​
metadata
object

Conjunto de pares clave-valor para almacenar información adicional sobre un objeto. Sigue el enfoque de Stripe con reglas de validación: máximo 50 claves, clave máximo 40 caracteres (sin corchetes), valor máximo 500 caracteres, todos los valores almacenados como cadenas.

Ejemplo:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string<uri>

URL HTTPS para recibir una solicitud POST cuando el lote se complete. Debe ser un URL públicamente accesible usando el protocolo http:// o https://. No puede apuntar a localhost o direcciones IP privadas. Consulta Webhooks para el formato de carga útil y el comportamiento de reintento.

Respuesta

Lote iniciado con éxito.

​
id
string

ID del Lote

​
object
string

El tipo de objeto. "batch" para este endpoint.

​
status
string

in_progress o completed

​
created
number

Época creada

​
total_urls
number

Conteo de URLs en el lote

​
completed_urls
number

Conteo de URLs completadas

​
parser
string
​
country
string
​
metadata
object

Conjunto de pares clave-valor para almacenar información adicional sobre un objeto. Sigue el enfoque de Stripe con reglas de validación: máximo 50 claves, clave máximo 40 caracteres (sin corchetes), valor máximo 500 caracteres, todos los valores almacenados como cadenas.

Ejemplo:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string

URL del webhook para recibir la notificación de finalización

​
credits_consumed
integer | null

Número de créditos consumidos por esta solicitud. Se completa después de que la ejecución finaliza. Los créditos son la fuente de verdad para la facturación.

​
cost_usd
number | null

Costo estimado en USD para esta solicitud. Se completa después de que la ejecución finaliza. Calculado a partir de los créditos consumidos y tu tarifa de plan — 99% preciso, pero credits_consumed es el valor autoritativo.