Skip to main content
POST
Upload an image file directly.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Image upload form data (multipart/form-data)

Form data for uploading an image

companyId
string
required

Company ID

description
string

Alias for prompt. Optional description/tags for the image.

prompt
string

Optional description/tags for the image (e.g., "residents playing an activity", "food service"). Stored on the image and returned as prompt. Alias: description.

Response

Uploaded image details

Uploaded image response

id
string

Image ID

model
string

Model (upload)

prompt
string

Image description

provider
string

Provider (upload)

publicUrl
string

Public image URL

url
string

Image URL