Get task status
Check an enrichment task's status, progress, credits used, and error details. Use the task ID returned at creation.
Check every few seconds until status is completed, failed, or stopped, then read links.results. Failed and stopped tasks can still have useful results.
Required permissions: enrichments:tasks:read
Authorizations
X-API-Key or AuthorizationstringheaderrequiredWe recommend sending your Personal API Key in x-api-key. Datablist handles token renewal for you. Optionally, use an access token as Authorization: Bearer <token> if your application manages tokens itself. Send only one credential header.
Path parameters
taskIdstringrequiredCopy the task's returned @id unchanged. New tasks use a 32-character hexadecimal UUID4; existing IDs with the task_ prefix remain supported.
"^(?:task_)?[a-f0-9]{32}$"Response
Task metadata without raw inputs
200 · application/json
@idstringrequired@typestringrequired"EnrichmentTask"enrichmentIdstringrequireduniqueIdstringrequired"^[A-Za-z0-9_-]+$"minLength: 1maxLength: 128statusstringrequiredThe task is active while queued, running, or stop_asked. Read results after completed, failed, or stopped. Reaching maxCredits can finish with partial results. A stop ends in stopped unless the task also fails.
"queued", "running", "stop_asked", "completed", "failed", "stopped"errorobject | nullrequiredNull while the task is active or successfully completed. On failure, includes error details and a traceId when available. A stopped task can keep an error that occurred before it stopped.
Show child attributes
reasonstringrequiredStable reason for a failed task.
"dispatch_failed", "deadline_exceeded", "worker_failed", "enrichment_failed", "credits_error"codestringrequiredmessagestringrequiredtraceIdstring | nullrequiredcreatedAtstringrequired"date-time"startedAtstring | nullrequired"date-time"finishedAtstring | nullrequired"date-time"progressobjectrequiredShow child attributes
totalInputsintegerrequired1maximum: 10000finishedInputsintegerrequired0maximum: 10000outcomesobjectrequiredShow child attributes
successintegerrequired0noResultintegerrequired0errorintegerrequired0skippedintegerrequired0creditsobjectrequiredShow child attributes
usedstringrequired"^[0-9]+(\\.[0-9]+)?$"maxstring | nullrequiredNull when the caller omitted maxCredits (no limit).
"^[0-9]+(\\.[0-9]+)?$"linksobjectrequiredShow child attributes
objectAdditional properties are supported.
kindstringrequired"enrichment"