Images
The Image service manages workspace image assets — generation, editing, upscaling, and retrieval — backed by the image-models registry.
Concepts
Images
Images are stored per workspace. Each image has a unique ID and can be listed, fetched, or deleted via the workspace-scoped endpoints.
Image Models
The image-models endpoint returns the catalogue of generation backends available to your workspace. Use the model identifier when creating generation, edit, or upscale tasks.
Tasks
Generation, edit, and upscale operations are asynchronous tasks:
- Generation tasks — Create a new image from a text prompt
- Edit tasks — Modify an existing image (inpainting, masked edits)
- Upscale tasks — Increase resolution of an existing image
Submit a task with POST and poll for the result through the matching images/{imageId} endpoint once the task settles.
Endpoints
All endpoints use the base path: https://app.neuroflash.com/api/image-service
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/workspaces/{id}/images | List images |
POST | /v1/workspaces/{id}/images | Upload an image |
GET | /v1/workspaces/{id}/images/{imageId} | Get a single image |
DELETE | /v1/workspaces/{id}/images/{imageId} | Delete an image |
GET | /v1/workspaces/{id}/image-models | List available image models |
POST | /v1/workspaces/{id}/image-generation-tasks | Submit a generation task |
POST | /v1/workspaces/{id}/image-edit-tasks | Submit an edit task |
POST | /v1/workspaces/{id}/image-upscale-tasks | Submit an upscale task |