Grok Imagine
About
Generates and edits images
Model id grok-image, sent to POST https://api.dev.sume.com/v1/image-router/generate.
1. Calling the API
Install the client
npm install @sume-com/client
Setup your API key
Set SUME_API_KEY as an environment variable in your server runtime. Make the key in Sume API → API keys.
export SUME_API_KEY="YOUR_API_KEY"
Submit a request
This sends the Playground's request, with the input it holds now. Change the input there and this updates. subscribe submits it, waits for the job and returns the result.
import { createSumeClient } from "@sume-com/client";
const sume = createSumeClient({ baseURL: "https://api.dev.sume.com" });
const response = await sume.subscribe("/v1/image-router/generate", {
input: {
"model": "grok-image",
"prompt": "Editorial product photograph: a frosted glass perfume bottle standing on warm sandstone beside a sprig of olive leaves, soft morning sunlight, shallow depth of field, calm neutral palette. No text, no logo.",
"aspect_ratio": "4:3"
},
});
console.log(response.status, response.images?.[0]?.url);2. Authentication
API key
Send your Sume API key as a bearer token from server code only. Keys made under Sume API → API keys spend the workspace balance, the same one Studio spends, and call the model API only.
Authorization: Bearer $SUME_API_KEY
3. Queue
A submit answers at once with the job. Poll its status until it is completed, failed or canceled. Failed and canceled jobs are refunded.
Fetch request status
const response = await fetch(`https://api.dev.sume.com/v1/jobs/${jobId}/status`, {
headers: { authorization: `Bearer ${process.env.SUME_API_KEY}` },
});
const { data: job } = await response.json();Get the result
A completed job returns its media. A queued or running job answers 409 job_not_completed with the current status; a failed one 409 job_failed with the reason, and a canceled one 409 job_canceled.
const response = await fetch(`https://api.dev.sume.com/v1/jobs/${jobId}/result`, {
headers: { authorization: `Bearer ${process.env.SUME_API_KEY}` },
});
const { data: result } = await response.json();Cancel a request
A job can be canceled until generation starts.
const response = await fetch(`https://api.dev.sume.com/v1/jobs/${jobId}/cancel`, {
method: "POST",
headers: { authorization: `Bearer ${process.env.SUME_API_KEY}` },
});
const { data: job } = await response.json();4. Files
Hosted files (URL)
Fields that end in _url or _urls take public HTTPS URLs. Some hosts block or rate-limit fetches from servers.
Uploading files
Upload a local file to Sume's storage, then send the URL it returns.
import { readFile } from "node:fs/promises";
import { createSumeClient } from "@sume-com/client";
const sume = createSumeClient({ baseURL: "https://api.dev.sume.com" });
const url = await sume.uploadImage(await readFile("input.png"), "png");5. Schema
Input
modelstringrequired- "grok-image"
promptstringrequired- What the image shows.
image_urlsstring[]- Images to edit or follow (HTTPS).
aspect_ratiostring- Frame shape.Default value: "1:1"Possible enum values: 2:1, 20:9, 19.5:9, 16:9, 4:3, 3:2, 1:1, 2:3, 3:4, 9:16, 9:19.5, 9:20, 1:2
{
"model": "grok-image",
"prompt": "Editorial product photograph: a frosted glass perfume bottle standing on warm sandstone beside a sprig of olive leaves, soft morning sunlight, shallow depth of field, calm neutral palette. No text, no logo.",
"aspect_ratio": "4:3"
}Output
data.result.artifactsArtifact[]required- The generated media, in order.
data.jobJobrequired- The job record: id, status, model, input, created_at, started_at and completed_at.
Artifact
urlstringrequired- Public Sume CDN URL for the file. Do not parse the path.
typestringrequired- image, video, audio, model or file.
content_typestringrequired- The file's MIME type.
idstringrequired- Opaque artifact id, safe to log.
widthinteger- Pixels, when known.
heightinteger- Pixels, when known.
duration_msinteger- Length of a video or audio file, when known.
size_bytesinteger- File size, when known.
6. Price before you submit
The estimate is the charge: the same function prices both. This one prices the Playground's input.
const response = await fetch("https://api.dev.sume.com/v1/open/estimate", {
method: "POST",
headers: { "content-type": "application/json" },
body: JSON.stringify({
"model": "grok-image",
"input": {
"prompt": "Editorial product photograph: a frosted glass perfume bottle standing on warm sandstone beside a sprig of olive leaves, soft morning sunlight, shallow depth of field, calm neutral palette. No text, no logo.",
"aspect_ratio": "4:3"
}
}),
});
const { data } = await response.json();
console.log(data.usd);Full reference: /docs