Vai al contenuto principale
POST
Avvia un nuovo batch
Ricevi una notifica al completamento: Passa il parametro webhook con l’URL del tuo endpoint per ricevere un HTTP POST quando il batch è completato. Vedi Webhooks per i dettagli.
Allega dati personalizzati: Usa il parametro metadata per memorizzare coppie chiave-valore. Supportato a due livelli:
  • Livello batch — nel corpo della richiesta
  • Livello elemento — su ciascun elemento nell’array items
Vedi Metadata per i dettagli.

Autorizzazioni

Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer del tipo Bearer , dove è il tuo token di autenticazione.

Corpo

application/json
items
object[]
obbligatorio

Array di elementi da elaborare nel batch.

country
string

Paese per l'esecuzione del batch. Fornisci in codici ISO 3166-1 alpha-2 come US(Stati Uniti), IN(India), ecc.

parser
object

Puoi usare questo parametro per specificare il parser da usare. I parser sono utili per estrarre contenuti strutturati dalle pagine web. Olostep ha alcuni parser integrati per le pagine web più comuni, e puoi anche creare i tuoi parser.

Ottieni tutti i link presenti su ogni pagina nel batch. I link sono sempre restituiti come URL assoluti.

metadata
object

Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive su un oggetto. Segue l'approccio di Stripe con regole di validazione: massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre), valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.

Esempio:
webhook
string<uri>

URL HTTPS per ricevere una richiesta POST quando il batch è completato. Deve essere un URL pubblicamente accessibile usando il protocollo http:// o https://. Non può puntare a localhost o indirizzi IP privati. Vedi Webhooks per il formato del payload e il comportamento di retry.

Risposta

Batch avviato con successo.

id
string

ID del Batch

object
string

Il tipo di oggetto. "batch" per questo endpoint.

status
string

in_progress o completed

created
number

Epoch creato

total_urls
number

Conteggio degli URL nel batch

completed_urls
number

Conteggio degli URL completati

parser
string
country
string
metadata
object

Insieme di coppie chiave-valore per memorizzare informazioni aggiuntive su un oggetto. Segue l'approccio di Stripe con regole di validazione: massimo 50 chiavi, chiave massimo 40 caratteri (senza parentesi quadre), valore massimo 500 caratteri, tutti i valori memorizzati come stringhe.

Esempio:
webhook
string

URL del webhook per ricevere la notifica di completamento

credits_consumed
integer | null

Numero di crediti consumati da questa richiesta. Popolato dopo il completamento dell'esecuzione. I crediti sono la fonte di verità per la fatturazione.

cost_usd
number | null

Costo stimato in USD per questa richiesta. Popolato dopo il completamento dell'esecuzione. Calcolato dai crediti consumati e dalla tua tariffa del piano — 99% accurato, ma credits_consumed è il valore autorevole.