Consistency reference
LiveName a character, a location or an object and describe it. Get one clean reference image to keep it looking the same across every shot you make.
Consistency reference
Input
kindcharacter, location or object.A wide, empty establishing view of the place.nameWhat it is called.descriptionWhat it looks like.styleThe visual style, e.g. anime or film noir.$0.1963 per image.
These tools need an API key with the api:opennan scope: paste one under Use API key to run them.
How it works
- 01Describe itA name, a look and a style; a photo for a character if you have one.
- 02We draw the referenceA portrait, an empty establishing view or a product shot.
- 03Reuse itSend it as a reference image with every shot.
Call Consistency reference from your code
One endpoint and one key, on the same balance as the playground. The request below is the example's own.
https:/ / api.opennan.com/ v1/ consistency/ referencesGet an API key
Create a key in the console. It uses the same balance as the playground.
Create a keySend your first request
The same request the playground sends. Set OPENNAN_KEY to your key.
curl https://api.opennan.com/v1/consistency/references \ -H "Authorization: Bearer $OPENNAN_KEY" \ -H "Content-Type: application/json" \ -d '{"kind":"location","name":"Snowy log cabin","description":"A small wooden log cabin on a snowy mountain slope at dusk, warm light glowing in the windows, smoke from a stone chimney, pine trees and snow-covered peaks behind","style":"warm 3D animation"}' # Then poll until "status" is "succeeded" or "failed": curl https://api.opennan.com/v1/tasks/<task id> -H "Authorization: Bearer $OPENNAN_KEY"Poll the task
The call answers right away with a task id. Ask for the task until it finishes:
GEThttps:// api.opennan.com/ v1/ tasks/ {id} - queued
- Waiting for a worker
- running
- Being made
- succeeded
- Done: outputs[].url holds the files
- failed
- Failed: you are not charged
Errors and how to fix them
401Missing or wrong key
Send the header Authorization: Bearer with a key from the console.
402Balance too low
Add credit in Billing, then send the same call again.
400A value is not accepted
Read error.message: it names the field. Use a value from the parameter table.
429Too many requests
Wait a few seconds and try again, waiting longer after each 429.
Add Opennan to your AI app
One install gives your AI every Opennan tool: video, images, chat, voice, music, sound effects, 3D, captions and dubbing. Pick your app and follow the steps.
https:/ / api.opennan.com/ v1/ mcpWorks in the Codex CLI, the Codex app and the Codex IDE extension: they share ~/.codex/config.toml. If the app or IDE does not see OPENNAN_KEY, use the config.toml option with your key in it. Codex asks before each tool call: approve it to go on.
Get an API key
Create a key in the console. It starts with sk- and uses the same balance as the website.
Create a keySave your key as OPENNAN_KEY
# macOS / Linux (zsh shown; bash: ~/.bashrc) echo 'export OPENNAN_KEY="sk-..."' >> ~/.zshrc source ~/.zshrc # Windows (PowerShell), then open a new terminal setx OPENNAN_KEY "sk-..."Install the Opennan plugin: the server plus a skill that teaches your AI to pick models, confirm prices and wait for results
codex plugin marketplace add Opennan/opennan-ai-plugin codex plugin add opennan@opennanOr add only the server
codex mcp add opennan --url https://api.opennan.com/v1/mcp --bearer-token-env-var OPENNAN_KEYOr add this to ~/.codex/config.toml
[mcp_servers.opennan] url = "https://api.opennan.com/v1/mcp" http_headers = { Authorization = "Bearer sk-..." }Check that opennan is listed
codex mcp listRestart Codex, then ask for anything
“Make a 5 second video of rain on a neon street, a song to go with it and a poster image.”
Replace sk-... with your own key and keep it private: anyone who has it can spend your balance. Your app can list the tools before you add a key; making anything needs one.
This tool from your AI
Once Opennan is added, your AI calls this tool with arguments like these.
- Tool
- generate_reference_image
- Example arguments
{ "kind": "location", "name": "Snowy log cabin", "description": "A small wooden log cabin on a snowy mountain slope at dusk, warm light glowing in the windows, smoke from a stone chimney, pine trees and snow-covered peaks behind", "style": "warm 3D animation" }
Consistency reference: questions
How much does Consistency reference cost?
From $0.1313 per image. The Run button shows the exact price for your input before you start.
How do I call it from my code?
Send POST https://api.opennan.com/v1/consistency/references with your API key. It answers with a task id: ask https://api.opennan.com/v1/tasks/{id} until the task succeeds or fails.
Can my AI agent use it?
Yes. Add the MCP server https://api.opennan.com/v1/mcp and call the generate_reference_image tool, or point your agent at https://api.opennan.com/llms.txt.
What happens if a run fails?
A failed run is not charged. You pay only for results.
Which API key do I need?
A key with the api:opennan scope. A full api key does not include it: create one with that scope in the console, then use it here under Use API key or in your code.
