Generate Effect V1

Purpose

Generates an effect-style result asynchronously. You can provide a text description and optionally upload an image to guide the effect generation.

Method and Path

POST /public/v1/generate/effect/v1

Authentication

See the Authentication page. Bearer token is required.

Required Headers:

Authorization: Bearer {your_api_key}

Request Fields

Field Name	Type	Required	Description
description	string	Yes	Text description of the effect to generate
resolution	string	Yes	Output resolution. Allowed values: 1K, 2K, 4K
image	file	No	Optional reference image file to guide the effect generation

Response

Success Response (200 OK):

{
  "job_id": "uuid-string"
}

Field	Type	Description
job_id	string	Unique identifier for the created job. Use Get Job Status to retrieve results

Error / Validation Rules

Condition	HTTP Status	Error Message
Invalid image file	400	"Invalid image file"
Invalid API key	401	Invalid API key

Async Job Behavior

This endpoint creates an asynchronous job. It immediately returns a job_id, and actual effect generation occurs in the background.

Polling Method:

1. Save the job_id received in the response
2. Poll GET /public/v1/job/{job_id} to check status
3. When status becomes Succeed, check results in image_urls

Status Flow: Pending → Succeed or Failed

Example Request

cURL (without image):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (with image):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "resolution=2K" \
-F "image=@/path/to/input.png"