Skip to content

Task-Status abrufen (get_task)

Längere Jobs laufen bei HiWalter asynchron. Der startende Endpunkt gibt eine task_id zurück, mit get_task fragst du Fortschritt und Ergebnis ab.

Frage alle 5 Sekunden ab. Bereits fertige Zeilen stehen in partial_results, du musst also nicht auf das Ende warten.

Nutze diesen Endpunkt, um:

  • das Ergebnis von validate_icp, segment_companies, research_companies, enrich_companies, match_companies und find_email abzurufen
  • einen laufenden Task mit cancel: true abzubrechen (fertige Zeilen bleiben erhalten)

Kostenlos: Statusabfragen zählen nicht gegen dein Fair-Use-Kontingent.

POST https://api.hiwalter.de/api/v1/tools/get_task

Übergib deinen API-Schlüssel als Bearer-Token im Authorization-Header. Schlüssel folgen dem Format hw_XXXXXXXXXXX.

Der Body wird als application/json gesendet. task_id ist Pflicht.

ParameterTypBeschreibung
task_idstringID des Tasks.
cancelbooleanBricht den Task ab. Standard: false.
cursorstringCursor für große Ergebnisse (ab 1.000 Zeilen).
Terminal window
curl --request POST \
--url https://api.hiwalter.de/api/v1/tools/get_task \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"task_id": "tsk_7f3a91"
}
'
{
"task_id": "tsk_7f3a91",
"type": "validate_icp",
"status": "running",
"progress": {
"done": 640,
"total": 1840
},
"partial_results": [
"…"
],
"results": null,
"next_cursor": null
}
FeldTypBeschreibung
typestringArt des Tasks.
statusstringqueued, running, completed, failed oder cancelled.
progressobjectErledigte und gesamte Zeilen.
partial_resultsarrayBereits fertige Zeilen, solange der Task läuft.
resultsarrayVollständiges Ergebnis, sobald status = completed.
next_cursorstringCursor für die nächste Ergebnisseite.