Skip to main content
Glama
runapi-ai
by runapi-ai

edit_image

Edit existing images by submitting a prompt and source image URLs to create a GPT Image task; returns task ID, status, and output URLs.

Instructions

Create a GPT Image task on RunAPI (edit image). Returns a task id, status, and output URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
waitNoPoll until the task reaches a terminal status.
modelNoRunAPI model slug for this model line.
promptYesDeclared type: string.
qualityYesDeclared type: string. Known values: "medium", "high".
timeout_msNo
aspect_ratioYesDeclared type: string. Known values: "1:1", "2:3", "3:2".
callback_urlNoDeclared type: string.
poll_interval_msNo
source_image_urlsYesDeclared type: array.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv0.2.0
    • changedInput schema / additionalProperties
      Previous value: -falseNew value: +{}
    • addedInput schema / properties / aspect_ratio / description
      Added value: +"Declared type: string. Known values: \"1:1\", \"2:3\", \"3:2\"."
    • removedInput schema / properties / aspect_ratio / enum
      Removed value: -[
      -  "1:1",
      -  "2:3",
      -  "3:2"
      -]
    • addedInput schema / properties / callback_url / description
      Added value: +"Declared type: string."
    • removedInput schema / properties / model / enum
      Removed value: -[
      -  "gpt-image-1.5"
      -]
    • addedInput schema / properties / poll_interval_ms / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / prompt / description
      Added value: +"Declared type: string."
    • addedInput schema / properties / quality / description
      Added value: +"Declared type: string. Known values: \"medium\", \"high\"."
    • removedInput schema / properties / quality / enum
      Removed value: -[
      -  "medium",
      -  "high"
      -]
    • addedInput schema / properties / source_image_urls / description
      Added value: +"Declared type: array."
    • addedInput schema / properties / timeout_ms / maximum
      Added value: +9007199254740991
  2. Changed5 schema fields changedv0.1.8
    • addedInput schema / properties / callback_url
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / prompt / type
      Added value: +"string"
    • addedInput schema / properties / source_image_urls / items
      Added value: +{}
    • addedInput schema / properties / source_image_urls / type
      Added value: +"array"
    • changedInput schema / required
      Previous value: -[
      -  "quality",
      -  "aspect_ratio"
      -]New value: +[
      +  "prompt",
      +  "source_image_urls",
      +  "aspect_ratio",
      +  "quality"
      +]
  3. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden, and it does disclose that this is an asynchronous task-creation call returning a task id, status, and output URLs. However, it omits permissions/auth needs, rate limits, and the polling lifecycle (the schema's wait/poll_interval_ms hint at polling, and get_task exists as a sibling), which matters for a no-annotation mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the action and ends with the return contract; nothing is padded. The parenthetical "(edit image)" is mildly redundant with the tool name but does clarify the operation mode, so it earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 9-parameter tool with no annotations and no output schema, the description is thin: it never explains the asynchronous polling model, how source_image_urls relates to prompt, or when to follow up with get_task. The one sentence on return values is helpful but does not cover enough for the tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 78%, so the schema documents most parameters (quality known values, aspect_ratio enums, wait semantics). The description adds no parameter-level meaning whatsoever, neither clarifying prompt, source_image_urls, nor the model slug. Baseline 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Create a GPT Image task") and names the mode ("edit image"), which implicitly distinguishes it from the text_to_image sibling. It also names the return payload (task id, status, output URLs). It stops short of explicitly contrasting itself with text_to_image, but the purpose is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no statement of when to use this tool versus alternatives, no prerequisites, and no routing to siblings like text_to_image or get_task. The only hint is the parenthetical "(edit image)", which implies an edit workflow but never says so explicitly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools