BackgroundErase icon

BackgroundErase

Remove image backgrounds with BackgroundErase

Actions3

Make an API Call

AI-generated

Summary

Perform an arbitrary authorized HTTP request to the BackgroundErase API by specifying the relative URL path, HTTP method, optional headers, query parameters, and request body.

Inputs

  • URL (required) — Path relative to the BackgroundErase API, such as /v2/account
  • Method (required) — HTTP method to use for the request, one of GET, POST, PUT, PATCH, DELETE
  • Headers — Optional JSON object of HTTP headers to include in the request; the x-api-key header is added automatically from credentials and should not be included here
  • Query String — Optional JSON object of query string parameters to append to the URL
  • Body — Optional JSON object representing the request body; used only for methods that support a body (e.g., POST, PUT, PATCH)

Output shape

a single record containing the full HTTP response body, headers, and status code

Returns an object with 'body' containing the parsed response, 'headers' as a JSON object of response headers, and 'statusCode' as the HTTP status code; errors are returned as workflow errors unless continueOnFail is enabled, in which case error details appear in output JSON.

Examples

Example 1: Retrieve the current user account details

Set URL to /v2/account and Method to GET with no headers, query string, or body specified.

Example 2: Create a new resource via POST

Set URL to the relevant resource path, choose Method POST, and specify JSON 'Body' parameters as required by the API.

Links

Discussion