Documentation Index Fetch the complete documentation index at: https://docs.oxen.ai/llms.txt
Use this file to discover all available pages before exploring further.
Try Grok Imagine - Image Edit in the Workbench Run this model interactively, tune parameters, and compare outputs.
Model ID: xai-grok-imagine-image-editGrok Imagine - Image Edit is part of xAI’s Grok Imagine suite, a multimodal creative stack supporting image-to-image generation with strong prompt adherence, cinematic aesthetics, style adaptation (including anime), and advanced world/physics understanding. It excels in believable lighting, coherent composition, and production-ready outputs suitable for video game ads and creative workflows. This endpoint specifically handles text-to-image generation.
Example request Use the Workbench as a request builder: configure parameters for this model in the UI, then open the API tab to copy the exact cURL or Python call. Sync
Async
Async with SSE
See the image editing reference for more details. curl -X POST https://hub.oxen.ai/api/ai/images/edit \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" }'
curl -X POST https://hub.oxen.ai/api/ai/images/edit \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png", "output_format": "webp" }'
See the async queue reference for more details. # Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" }' | jq -r '.generations[0].generation_id' ) # Poll until the generation reaches a terminal status. while true ; do STATUS = $( curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq -r '.status' ) echo "Status: $STATUS " case $STATUS in succeeded | failed | cancelled ) break ;; esac sleep 5 done # Print the result. curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png", "output_format": "webp" }' | jq -r '.generations[0].generation_id' ) # Poll until the generation reaches a terminal status. while true ; do STATUS = $( curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq -r '.status' ) echo "Status: $STATUS " case $STATUS in succeeded | failed | cancelled ) break ;; esac sleep 5 done # Print the result. curl -s -H "Authorization: Bearer $OXEN_API_KEY " \ "https://hub.oxen.ai/api/ai/queue/ $GEN_ID " | jq .
See the async queue reference for more details. # Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png" }' | jq -r '.generations[0].generation_id' ) # Stream the SSE channel, grab the data line that follows a # media_generation_completed event for our id, and pretty-print it. curl -sN -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/events \ | awk -v id=" $GEN_ID " ' /^event: media_generation_completed$/ { expect=1; next } /^data: / && expect { payload = substr($0, 7) if (index(payload, "\"generation_id\":\"" id "\"")) { print payload; exit } expect = 0 } ' | jq .
# Enqueue, capture the generation id. GEN_ID = $( curl -s -X POST https://hub.oxen.ai/api/ai/queue \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OXEN_API_KEY " \ -d '{ "model": "xai-grok-imagine-image-edit", "prompt": "<prompt>", "input_image": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png", "output_format": "webp" }' | jq -r '.generations[0].generation_id' ) # Stream the SSE channel, grab the data line that follows a # media_generation_completed event for our id, and pretty-print it. curl -sN -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/events \ | awk -v id=" $GEN_ID " ' /^event: media_generation_completed$/ { expect=1; next } /^data: / && expect { payload = substr($0, 7) if (index(payload, "\"generation_id\":\"" id "\"")) { print payload; exit } expect = 0 } ' | jq .
Fetch model details The models endpoint returns the full model object, including its json_request_schema.
curl -H "Authorization: Bearer $OXEN_API_KEY " https://hub.oxen.ai/api/ai/models/xai-grok-imagine-image-edit
Request parameters Required parameters Field Type Default Description promptstring""Prompt for generated image input_imagestring— Image you want to edit. Format: uri.
Optional parameters Field Type Default Description output_formatstring"webp"Format of the output images One of: webp, jpg, png.
