Skip to main content
POST
/
v1
/
images
/
estimate
Estimate the credit cost of an image generation
curl --request POST \
  --url https://api.example.com/v1/images/estimate \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "prompt": "A golden sunset over mountains, cinematic lighting, 8k resolution",
  "negative_prompt": "blurry, low quality, watermark, text",
  "lora_id": "lora_01HXMQ7Z3K8Y2ABCDEFGHJKM",
  "width": 1024,
  "height": 1024,
  "steps": 30,
  "guidance_scale": 7.5,
  "seed": 42,
  "size": "hd_square",
  "count": 1,
  "enhance_prompt": false,
  "webhook_url": "https://your-server.com/webhooks/aurouslabs",
  "reference_image_urls": [
    "file_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
    "https://example.com/ref2.jpg"
  ]
}
'
{
  "object": "estimate",
  "estimated_cost": {
    "amount": 2,
    "breakdown": {
      "base": 1,
      "enhance": 1
    }
  },
  "currency": "credit"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aurous-labs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Your team API key (starts with al_live_ — legacy keys may start with og_).

Headers

​
Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Body

application/json
​
prompt
string
required

The text prompt describing the image to generate. 1-4000 characters; whitespace-only is rejected.

Required string length: 1 - 4000
Example:

"A golden sunset over mountains, cinematic lighting, 8k resolution"

​
negative_prompt
string

Negative prompt - elements to exclude from the generated image. 1-4000 characters.

Required string length: 1 - 4000
Example:

"blurry, low quality, watermark, text"

​
lora_id
string

Optional. Opaque LoRA identifier (lora_*) or URL-friendly slug, from GET /v1/loras. UUIDs are also accepted for legacy back-compat. If omitted, the platform will choose a suitable style based on your prompt; if none matches, your prompt is generated without a style.

Example:

"lora_01HXMQ7Z3K8Y2ABCDEFGHJKM"

​
width
number

Output image width in pixels (ignored if size preset is set)

Required range: 256 <= x <= 4096
Example:

1024

​
height
number

Output image height in pixels (ignored if size preset is set)

Required range: 256 <= x <= 4096
Example:

1024

​
steps
number

Number of diffusion steps (higher = more detail, slower)

Required range: 1 <= x <= 100
Example:

30

​
guidance_scale
number

Guidance scale - how closely to follow the prompt (higher = more literal)

Required range: 0.1 <= x <= 30
Example:

7.5

​
seed
number

Random seed for reproducible generations. Omit for random.

Example:

42

​
size
enum<string>

Size preset for the output image. Overrides width/height if set.

Available options:
square,
landscape,
portrait,
hd_square,
hd_landscape,
hd_portrait
Example:

"hd_square"

​
count
number

Number of images to generate in this request

Required range: 1 <= x <= 4
Example:

1

​
enhance_prompt
boolean

When true, an LLM rewrites your prompt before generation using the LoRA's style template. This is the only customer-facing prompt-shaping toggle in the public API. Pricing: enhanced generations cost a configurable multiplier of the base rate.

Example:

false

​
webhook_url
string

Optional webhook URL. When provided, a POST request will be sent to this URL when the generation completes or fails. The payload contains an event field ("image.completed" or "image.failed") and a data field with the generation details (same shape as GET /v1/images/:id). Delivery is attempted up to 3 times with a 2-second delay between retries.

Example:

"https://your-server.com/webhooks/aurouslabs"

​
reference_image_urls
string[]

Up to 6 reference images. Each entry can be either:

  • an opaque file ID file_<ulid> returned by POST /v1/files, or
  • an https:// URL pointing at a public host (max 2048 chars). URLs are server-side fetched through an SSRF-pinned client (rejects private IPs / loopback / link-local / cloud metadata) and materialized as a 24h-TTL file under your team. Pricing matches the reference-image rate (see Pricing). Empty array or omitted is treated as "no references".
Maximum array length: 6
Example:
[
  "file_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
  "https://example.com/ref2.jpg"
]

Response

Cost estimate

​
object
enum<string>
required

Discriminator

Available options:
estimate
Example:

"estimate"

​
estimated_cost
object
required

Cost breakdown for this would-be generation.

​
currency
enum<string>
required

Currency unit. All amounts in this response are in credit.

Available options:
credit
Example:

"credit"