Skip to main content
ImageRouter logo
  • Category: ai content generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: IMAGEROUTER
  • Version: 00000000_00

Tools

Slug: IMAGEROUTER_CREATE_CHAT_COMPLETIONCreate a non-streaming OpenAI-compatible chat completion with a paid text model. Call IMAGEROUTER_LIST_MODELS, IMAGEROUTER_GET_MODEL, and IMAGEROUTER_GET_CREDITS first to verify availability, context, supported parameters, pricing, and sufficient credits.

Input Parameters

string
required
Exact text-output model ID from IMAGEROUTER_LIST_MODELS. Inspect its context, supported parameters, and pricing before this paid call.
array
OpenAI-compatible function tool definitions available to the model.
number
Nucleus-sampling probability mass from 0 to 1.
array
required
OpenAI-compatible conversation messages in chronological order.
integer
Maximum number of completion tokens.
number
Sampling temperature supported by the selected model.
string
OpenAI-compatible tool-selection policy as a keyword or policy object.
object
OpenAI-compatible response format configuration, including structured output.
string
Reasoning effort for selected models that support this parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_CREATE_RESPONSECreate a non-streaming OpenAI Responses API result from plain text or structured multimodal input with a selected ImageRouter text model. Call IMAGEROUTER_LIST_MODELS and IMAGEROUTER_GET_CREDITS first because all text models observed during probing were paid. Streaming and SSE are not supported.

Input Parameters

object
Text output and structured-format configuration.
string
required
Plain prompt text or OpenAI Responses input items. Structured items may include model-supported multimodal content such as input_image parts.
string
required
Exact text-output model ID from IMAGEROUTER_LIST_MODELS. Inspect the model’s capabilities and pricing first because this call may consume credits.
array
OpenAI Responses-compatible tool definitions passed to the selected model.
number
Nucleus-sampling probability mass, from 0 to 1.
object
Reasoning configuration supported by the selected model.
number
Sampling temperature, when supported by the selected model.
string
OpenAI Responses-compatible tool-selection policy.
string
Optional system-level guidance for the response.
integer
Maximum number of output tokens to generate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_EDIT_IMAGETransform or inpaint one or more existing images supplied as URLs or data URIs. Call IMAGEROUTER_LIST_MODELS and inspect the selected model first to verify image and optional mask input support, accepted parameters, pricing, and funding requirements. Multipart file uploads are not supported.

Input Parameters

string
Model-supported WIDTHxHEIGHT value or auto. Omit to use its default.
array
Optional mask URLs or data URIs for a model that accepts mask input. Provide 1-16 JSON string values when used.
string
required
Exact model ID from IMAGEROUTER_LIST_MODELS whose architecture accepts image input. Inspect its capabilities and pricing before editing.
array
required
Source image URLs or data URIs. Provide 1-16 JSON string values; binary multipart files are not supported.
string
required
Describe the requested transformation or inpainting result.
string ("auto" | "low" | "medium" | "high")
Requested quality. Omit unless the selected model lists quality as a supported parameter.
string ("webp" | "jpeg" | "png")
Edited image file format.
string
Output transport. Only URL output is supported to keep results bounded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_GENERATE_IMAGEGenerate an image from a text prompt with a selected ImageRouter model. Call IMAGEROUTER_LIST_MODELS and inspect the selected model first because pricing, supported sizes and quality levels, and funding requirements vary. Results are returned as URLs; inline base64 output is not supported.

Input Parameters

string
Model-supported WIDTHxHEIGHT value or auto. Omit to use its default.
string
required
Exact image model ID from IMAGEROUTER_LIST_MODELS. Inspect the model’s capabilities and pricing before generation because production calls may consume credits or require a funded account.
string
required
Text description of the image to generate.
string ("auto" | "low" | "medium" | "high")
Requested quality. Omit unless the selected model lists quality as a supported parameter.
string ("webp" | "jpeg" | "png")
Generated image file format.
string
Output transport. Only URL output is supported to keep results bounded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_GENERATE_VIDEOGenerate a video from text and optional URL or data-URI image inputs. Call IMAGEROUTER_LIST_MODELS and inspect the selected model first because pricing, accepted modalities, quality levels, sizes, and duration constraints vary. Results are returned as URLs; inline base64 output is not supported.

Input Parameters

string
Model-supported WIDTHxHEIGHT value or auto. Omit to use its default.
string
required
Exact video model ID from IMAGEROUTER_LIST_MODELS. Inspect the model’s capabilities and pricing before generation because production calls may consume credits or require a funded account.
array
Optional source image URLs or data URIs for image-to-video models. Multipart files are not supported.
string
required
Text description of the video to generate.
string ("auto" | "low" | "medium" | "high")
Requested quality. Omit unless the selected model lists quality as a supported parameter.
integer
Requested duration in seconds. Omit for the provider’s auto default; each model supports its own subset.
string
Output transport. Only URL output is supported to keep results bounded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_GET_CREDITSInspect remaining credits, cumulative usage, deposits, and optional per-key usage before making potentially paid generation calls.

Input Parameters

boolean
Include usage and spend metadata grouped by API key. Secret key values are not returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_GET_MODELGet current capabilities, accepted parameters, and pricing for one exact ImageRouter model ID before generation.

Input Parameters

string
required
Exact model ID returned by IMAGEROUTER_LIST_MODELS, such as openai/gpt-image-2.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: IMAGEROUTER_LIST_MODELSDiscover current ImageRouter model IDs, modalities, supported parameters, and pricing before generation. Filters may be combined. limit truncates results and cannot be continued; omit it for an exhaustive filtered list.

Input Parameters

boolean
Set true for zero-priced models or false for paid models. Zero price does not guarantee access from an unfunded account.
string
Case-insensitive partial model name, ID, or alias filter.
string ("name" | "provider" | "price" | "date")
Sort by name or provider alphabetically, price ascending, or date newest first.
integer
Truncate the returned array to at most this many models. There is no next page or continuation token.
string
Comma-separated response fields to include, such as architecture,pricing,supported_parameters,parameters,aliases. The model ID is always returned.
string
Case-insensitive partial provider filter.
string ("image" | "mask" | "text" | "audio" | "video")
Return models accepting this input modality.
string ("image" | "video" | "text")
Return models producing this modality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not