Skip to content
Book a callStart free
Reference

list_callbacks

List callback deliveries

View as Markdown

GET /api/v2/callbacks

Needs the results:read scope.

Query

NameTypeRequiredDescription
limitintegernoDefault 20.
cursorstringnoThe next_cursor of the last page.

Example

curl "https://app.diffusr.ai/api/v2/callbacks?limit=20" \
-H "Authorization: Bearer $DIFFUSR_KEY"

Response

200 ApiCallbackDeliveryList

Your callback delivery log, newest first.

NameTypeRequiredDescription
deliveriesobject[]yesNewest first.
deliveries[].event_idstringyes
deliveries[].type“result.finished”yes
deliveries[].result_idstringyesThe job this event is about.
deliveries[].urlstringyes
deliveries[].status“PENDING” | “DELIVERED” | “FAILED”yesPENDING = will be tried (again); DELIVERED = your server answered 2xx; FAILED = we gave up.
deliveries[].attemptsintegeryes
deliveries[].last_status_codeintegerno
deliveries[].last_errorstringno
deliveries[].last_attempt_atstringno
deliveries[].next_attempt_atstringno
deliveries[].delivered_atstringno
deliveries[].created_atstringyes
deliveries[].testtrueno
next_cursorstringnoPass as cursor for the next page. Absent on the last page.

Errors

Every error body is { error, code, request_id, ... }. All codes and what to do.

  • 401: Missing, wrong, revoked or expired API key (code UNAUTHORIZED, KEY_REVOKED, KEY_EXPIRED).
  • 403: The key may not do this (SCOPE_DENIED, MODEL_NOT_ALLOWED, TEST_MODE_UNSUPPORTED, ACCOUNT_BLOCKED, allowance_exceeded).
  • 422: The request is not valid (VALIDATION_FAILED, INVALID_JSON, PREFLIGHT_FAILED, CALLBACK_URL_INVALID, REFERENCE_*). `issues` lists each problem. Nothing was charged.
  • 429: Too many requests or jobs (RATE_LIMITED, CONCURRENCY_LIMIT, UPLOAD_QUOTA, …). Wait Retry-After seconds, then retry.
  • 500: Our fault (INTERNAL_ERROR). Quote request_id to support.
  • 503: Paused or busy (API_PAUSED, MODEL_PAUSED, PROVIDER_PAUSED, PROVIDER_BUSY, UNAVAILABLE). Wait Retry-After seconds, then retry.

Charges

Free. No credits are spent.