Async & webhooks

Poll an async job

This endpoint reports the status of a job created with async: true and its result once finished. The endpoint is scoped to your account. You can read only your own jobs. The endpoint never charges credits.

get/v1/jobs/{id}

Request

  • Base URL: https://api.thecompound.tech
  • URL: https://api.thecompound.tech/v1/jobs/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The jobId returned by the 202.

Response

The job's current state.

jobIdstring uuid required
endpointstring required

The job runs with this endpoint key.

status'queued' | 'running' | 'succeeded' | 'failed' required

Terminal states are succeeded and failed.

resultobject

This field is present only when status is succeeded. It contains the same body the sync call would have returned, including usage.

errorstring

This field is present only when status is failed. No credits were charged.

createdAtstring date-time required
updatedAtstring date-time required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.