Endpoints
Image Generation
Generate provider-neutral AI image assets for your active business.
POST
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.
Your API key from Settings > API Keys.
Request body
| Name | Type | Required | Default | Notes |
|---|---|---|---|---|
prompt | string | yes | - | Description of the image you want, 1-1000 characters. |
preset | enum | no | social_graphic | Output intent: social_graphic, gbp_post, ad_creative, product_photo, or blog_hero. |
style | enum | no | - | Optional visual treatment: photorealistic, illustration, minimal, or bold. |
Example
Response
| Field | Type | Notes |
|---|---|---|
url | string | Generated image URL. Download or save the asset in your workflow before relying on long-term availability. |
watermarked | boolean | Whether the output includes NearIQ watermarking for the current plan. |
usage | object | Daily image-generation usage for the billing account. |
_receipt | object | Request metadata for audit and support. |
Errors
| Status | Meaning |
|---|---|
400 | Invalid request body. |
403 | Plan or API-key scope does not allow image generation. |
429 | Daily image generation limit reached. |
503 | Image generation is not configured for the current environment. |