Skip to content
Book a callStart free
Reference

ads_get_launch

Get one ad launch

View as Markdown

GET /api/v2/ads/launches/{id}

Needs the ads:read scope.

Path

NameTypeRequiredDescription
idstringyesThe job id from a make call.

Example

curl "https://app.diffusr.ai/api/v2/ads/launches/LAUNCH_ID" \
-H "Authorization: Bearer $DIFFUSR_KEY"

Response

200 ApiAdsLaunch

The launch and where it stands.

NameTypeRequiredDescription
idstringyes
statusstringyes
stepstring | nullyes
errorstring | nullyes
platformstringyes
accountstringyes
namestringyes
daily_budgetnumberyes
currencystringyes
review_urlstring | nullyes
open_urlstring | nullyes
live_atstring | nullyes
nextstringyes

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).
  • 404: No such id, or it is not yours, or it belongs to the other key mode (NOT_FOUND).
  • 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.