Cancel job
WriteStops a PENDING or PROCESSING job.
Permissions and limits
Account permissions
- An ImageStep API key (is_sk_...)
A repeated request may repeat the external action. Review the previous result before retrying a write.
Run deterministic ImageStep image ops (resize, convert, crop, overlay, templates and more) as jobs and manage assets, templates and presets.
Explore 33 workflow actions for ImageStep, including account permissions and operation limits.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Stops a PENDING or PROCESSING job.
A repeated request may repeat the external action. Review the previous result before retrying a write.
How many of your jobs are in each status and of each type, as one table: a row per status and type that has any, with its count.
Saves version 1 and answers 201 with the preset as saved.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Creates version 1 and answers 201 with it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes an asset and queues its stored objects for removal.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes multiple assets and queues their stored objects for removal.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the preset and every version of it; every slug@N a caller holds answers 404 presetnotfound from then on.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Drops slug@version from the preset's history.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Deletes the template and every version of it.
A repeated request may repeat the external action. Review the previous result before retrying a write.
One asset's full record: the list row's fields plus image (type, pixel size, bytes, SHA-1 and the facts ingest derived), metadata (what exiftool read), takenAt and, for anything a job made, lineage.
Where a batch of your assets is in ingest, in one call , the poll after an upload or a URL ingest, instead of GET /api/v1/assets/{id} per asset per tick.
One job as it stands: its status, the item counts, what ran (op, preset and version, model, steps) and, per item, the output , resultAssetId, or output for an analyze , or, for a failed item,.
The catalogue entry of one op, as GET /api/v1/ops lists it: its parameters, its price, an example request and its synchronous endpoint.
{slug} is a slug or id for the current version, or slug@version for one version , the spelling POST /api/v1/jobs {presetId} and POST /api/v1/images/transform?preset= accept, so what a job ran can.
{id} is a template id (or your own slug) for the current version, or {id}@{version} for one specific version , the same spelling rendertemplate accepts as templateId, so what a job rendered with.
What was spent over a time window, grouped by atomic op, by API key, or by UTC day, with the window's total beside the groups: - jobs , jobs created in the window - credits and items , what those.
Fetches each public image URL here, stores it and creates an asset , the same asset an upload creates, in PROCESSING until ingest has written dimensions and metadata.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Every model an AI op can run on, across the providers behind this API.
Paginated list of the caller's assets, newest-created first.
Every collection your assets are in, one row each: the name, how many assets are in it and when the latest one was created , most recently added to first.
Everything this account has submitted, newest first, a page at a time.
One page of a job's items, in item order (index, from 0) , the number the rest of the API names an item by, in events and in a resume.
Your jobs, newest first, one page at a time.
Every atomic op, with what a program needs to call it without a list of its own.
Built-in presets first, then your own, most recently updated first.
Every version ever saved, newest first, each as a full document , html and css included , whose id is {id}@{version} and which has no slug, description or updatedAt.
Built-in templates first, then the caller's own, most recently updated first, a page at a time.
Moves every one of your assets in from to to, in one statement , the way to rename a collection, or with to: "" to take its assets out of any collection.
A repeated request may repeat the external action. Review the previous result before retrying a write.
USE THIS WHEN: an op you needed does not exist, a parameter did not behave the way the contract describes, or you were about to work around ImageStep with something local.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Submits an async job.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Updates the published status, the collection and the tags of multiple assets.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send only what changes: the body is merged over the current preset, and a field it leaves out keeps its value ({"name": "…"} is a whole rename; the slug stays unless you send one).
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send only what changes: the body is merged over the current version, and a field it leaves out keeps its value ({"width": 1080, "height": 1080} is a whole update); "" empties css or description.
A repeated request may repeat the external action. Review the previous result before retrying a write.
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
Inspect step outputs and confirm the result in ImageStep. A saved workflow is not a completed provider action.