Apply your first image effect

Ask the Backapp team for an AppKey and the base URL for your test environment. Use a small sample image and confirm whether provider charges apply before running this example.

Follow Authentication to register your device and obtain an access token.
Send GET /v2/image_effects with the app headers and bearer token. Choose an integer effect ID from the returned catalog.
Submit the file and selected effect. Set the environment variables below using your test credentials and the ID from step 2.

curl --fail-with-body "$BACKAPP_BASE_URL/v2/image_effects/apply" \
  -H "X-App-Key: $BACKAPP_APP_KEY" \
  -H "X-App-Version: $BACKAPP_APP_VERSION" \
  -H "Authorization: Bearer $BACKAPP_ACCESS_TOKEN" \
  -F "effect_id=$BACKAPP_EFFECT_ID" \
  -F "[email protected]"

A successful request returns HTTP 200 with an image_url. Display that URL in your app. The request completes synchronously. You may provide a prompt form field to override the configured effect prompt. For invalid_request, check error.fields and confirm the effect still appears in the catalog. For effect_failed, contact support if the error persists. After a timeout, the outcome may be unknown and resending the request can start another provider call.