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_companiesundfind_emailabzurufen - einen laufenden Task mit
cancel: trueabzubrechen (fertige Zeilen bleiben erhalten)
Kostenlos: Statusabfragen zählen nicht gegen dein Fair-Use-Kontingent.
POST https://api.hiwalter.de/api/v1/tools/get_taskAuthentifizierung
Section titled “Authentifizierung”Übergib deinen API-Schlüssel als Bearer-Token im Authorization-Header. Schlüssel folgen dem Format hw_XXXXXXXXXXX.
Anfrage
Section titled “Anfrage”Der Body wird als application/json gesendet. task_id ist Pflicht.
| Parameter | Typ | Beschreibung |
|---|---|---|
task_id | string | ID des Tasks. |
cancel | boolean | Bricht den Task ab. Standard: false. |
cursor | string | Cursor für große Ergebnisse (ab 1.000 Zeilen). |
Beispiel
Section titled “Beispiel”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"}'Antwort
Section titled “Antwort”{ "task_id": "tsk_7f3a91", "type": "validate_icp", "status": "running", "progress": { "done": 640, "total": 1840 }, "partial_results": [ "…" ], "results": null, "next_cursor": null}| Feld | Typ | Beschreibung |
|---|---|---|
type | string | Art des Tasks. |
status | string | queued, running, completed, failed oder cancelled. |
progress | object | Erledigte und gesamte Zeilen. |
partial_results | array | Bereits fertige Zeilen, solange der Task läuft. |
results | array | Vollständiges Ergebnis, sobald status = completed. |
next_cursor | string | Cursor für die nächste Ergebnisseite. |