Skip to main content
POST
/
images
curl https://app.neariq.io/api/v1/images \
  -X POST \
  -H "X-NearIQ-Key: niq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Modern gym interior with natural light and branded wall signage",
    "preset": "social_graphic",
    "style": "photorealistic"
  }'
POST /api/v1/images creates an AI-generated image for the active business attached to your API key. The response includes the generated image URL, watermark state, daily usage, and a request receipt. Use an API key with the content:write scope. This endpoint is available on Growth plans and higher.
X-NearIQ-Key
string
required
Your API key from Settings > API Keys.

Request body

NameTypeRequiredDefaultNotes
promptstringyes-Description of the image you want, 1-1000 characters.
presetenumnosocial_graphicOutput intent: social_graphic, gbp_post, ad_creative, product_photo, or blog_hero.
styleenumno-Optional visual treatment: photorealistic, illustration, minimal, or bold.

Example

curl https://app.neariq.io/api/v1/images \
  -X POST \
  -H "X-NearIQ-Key: niq_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Modern gym interior with natural light and branded wall signage",
    "preset": "social_graphic",
    "style": "photorealistic"
  }'

Response

{
  "url": "https://...",
  "prompt": "Modern gym interior with natural light and branded wall signage",
  "preset": "social_graphic",
  "watermarked": false,
  "disclaimer": null,
  "usage": {
    "used": 4,
    "limit": 25,
    "remaining": 21,
    "resetsAt": "2026-06-10T00:00:00.000Z"
  },
  "_receipt": {
    "requestId": "req_...",
    "generatedAt": "2026-06-09T16:20:00.000Z"
  }
}
FieldTypeNotes
urlstringGenerated image URL. Download or save the asset in your workflow before relying on long-term availability.
watermarkedbooleanWhether the output includes NearIQ watermarking for the current plan.
usageobjectDaily image-generation usage for the billing account.
_receiptobjectRequest metadata for audit and support.

Errors

StatusMeaning
400Invalid request body.
403Plan or API-key scope does not allow image generation.
429Daily image generation limit reached.
503Image generation is not configured for the current environment.
Generated images are scoped to your active business. Organization members also need the image-generation permission for team-owned businesses.