> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create image edit > Edit an Image ## OpenAPI ````yaml post /v2/router/images/edits openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://api.orq.ai security: - ApiKey: [] tags: - name: Guardrail Rules - name: Policies - name: Routing Rules - name: Files description: File upload and retrieval operations. - name: FilesService - name: Projects description: Projects organize resources within a workspace - name: ProjectsService - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: SkillsService - name: Responses - description: >- Run agents on a cadence — cron, interval, or one-off. Minimum firing interval is 1 hour. name: Agent Schedules - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: ReportingService description: |- ReportingService exposes a single QueryReport RPC that maps allowlisted analytics payloads onto safe rollup queries. Callers never send SQL; the backend picks the rollup family and grain from the metric catalogue, the requested range, and the requested grouping. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/router/images/edits: post: tags: - Images summary: Create image edit description: Edit an Image operationId: createImageEdit requestBody: required: true content: multipart/form-data: schema: type: object properties: model: type: string description: >- The model to use for image edit. [Check models](https://docs.orq.ai/docs/ai-gateway-supported-models#image-models) image: description: >- The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images. prompt: type: string description: A text description of the desired image(s). 'n': type: - number - 'null' minimum: 1 maximum: 10 default: 1 description: The number of images to generate. Must be between 1 and 10. size: type: - string - 'null' description: The size of the generated images quality: type: - string - 'null' enum: - auto - high - medium - low - standard - null description: >- The quality of the image that will be generated. Auto will automatically select the best quality for the given model. response_format: type: string enum: - url - b64_json description: >- The format in which the generated images are returned. Some of the models only return the image in base64 format. user: type: string description: >- A unique identifier representing your end-user, which can help to monitor and detect abuse. name: type: string description: >- The name to display on the trace. If not specified, the default system name will be used. fallbacks: type: array items: type: object properties: model: type: string description: Fallback model identifier required: - model description: Array of fallback models to use if primary model fails retry: type: object properties: count: type: number minimum: 1 maximum: 5 default: 3 description: Number of retry attempts (1-5) example: 3 on_codes: type: array items: type: number minimum: 100 maximum: 599 minItems: 1 default: - 429 description: HTTP status codes that trigger retry logic example: - 429 - 500 - 502 - 503 - 504 description: Retry configuration for the request cache: type: object properties: ttl: type: number minimum: 1 maximum: 259200 default: 1800 description: >- Time to live for cached responses in seconds. Maximum 259200 seconds (3 days). example: 3600 type: type: string enum: - exact_match required: - type description: Cache configuration for the request. load_balancer: oneOf: - type: object properties: type: type: string enum: - weight_based models: type: array items: type: object properties: model: type: string description: Model identifier for load balancing example: openai/gpt-4o weight: type: number minimum: 0.001 maximum: 1 default: 0.5 description: >- Weight assigned to this model for load balancing example: 0.7 required: - model required: - type - models description: Load balancer configuration for the request. timeout: type: object properties: call_timeout: type: number minimum: 1 description: Timeout value in milliseconds example: 30000 required: - call_timeout description: >- Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured. orq: type: object properties: name: type: string description: >- The name to display on the trace. If not specified, the default system name will be used. retry: type: object properties: count: type: number minimum: 1 maximum: 5 default: 3 description: Number of retry attempts (1-5) example: 3 on_codes: type: array items: type: number minimum: 100 maximum: 599 minItems: 1 default: - 429 description: HTTP status codes that trigger retry logic example: - 429 - 500 - 502 - 503 - 504 description: Retry configuration for the request fallbacks: type: array items: type: object properties: model: type: string description: Fallback model identifier example: openai/gpt-4o-mini required: - model description: Array of fallback models to use if primary model fails prompt: type: object properties: id: type: string description: Unique identifier of the prompt to use example: prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV version: type: string enum: - latest description: >- Version of the prompt to use (currently only "latest" supported) example: latest required: - id - version description: Prompt configuration for the request identity: $ref: '#/components/schemas/PublicIdentity' contact: $ref: '#/components/schemas/PublicContact' cache: type: object properties: ttl: type: number minimum: 1 maximum: 259200 default: 1800 description: >- Time to live for cached responses in seconds. Maximum 259200 seconds (3 days). example: 3600 type: type: string enum: - exact_match required: - type description: Cache configuration for the request. load_balancer: oneOf: - type: object properties: type: type: string enum: - weight_based models: type: array items: type: object properties: model: type: string description: Model identifier for load balancing example: openai/gpt-4o weight: type: number minimum: 0.001 maximum: 1 default: 0.5 description: >- Weight assigned to this model for load balancing example: 0.7 required: - model required: - type - models description: Array of models with weights for load balancing requests example: type: weight_based models: - model: openai/gpt-4o weight: 0.7 - model: anthropic/claude-3-5-sonnet weight: 0.3 timeout: type: object properties: call_timeout: type: number minimum: 1 description: Timeout value in milliseconds example: 30000 required: - call_timeout description: >- Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured. required: - model - prompt responses: '200': description: Represents an image edit response from the API. content: application/json: schema: type: object properties: created: type: number description: >- The Unix timestamp (in seconds) of when the image was created. output_format: type: string description: The output format of the image generation size: type: string description: The size of the image generated quality: type: string description: The quality of the image generated data: type: array items: type: object properties: b64_json: type: string description: >- The base64-encoded JSON of the generated image, if response_format is b64_json url: type: string description: >- The URL of the generated image, if response_format is url (default) description: The list of generated images. usage: type: object properties: total_tokens: type: number description: >- The total number of tokens (images and text) used for the image generation. input_tokens: type: number description: >- The number of tokens (images and text) in the input prompt. output_tokens: type: number description: The number of output tokens generated by the model. input_tokens_details: type: object properties: text_tokens: type: number description: The number of text tokens in the input prompt. image_tokens: type: number description: The number of image tokens in the input prompt. required: - text_tokens - image_tokens description: >- The input tokens detailed information for the image generation. required: - total_tokens - input_tokens - output_tokens - input_tokens_details description: The token usage information for the image generation. required: - created - data components: schemas: PublicIdentity: type: object properties: id: type: string description: Unique identifier for the contact example: contact_01ARZ3NDEKTSV4RRFFQ69G5FAV display_name: type: string description: Display name of the contact example: Jane Doe email: type: string format: email description: Email address of the contact example: jane.doe@example.com metadata: type: array items: type: object additionalProperties: {} description: >- A hash of key/value pairs containing any other data about the contact example: - department: Engineering role: Senior Developer logo_url: type: string description: URL to the contact's avatar or logo example: https://example.com/avatars/jane-doe.jpg tags: type: array items: type: string description: A list of tags associated with the contact example: - hr - engineering required: - id description: >- Information about the identity making the request. If the identity does not exist, it will be created automatically. PublicContact: type: object properties: id: type: string description: Unique identifier for the contact example: contact_01ARZ3NDEKTSV4RRFFQ69G5FAV display_name: type: string description: Display name of the contact example: Jane Doe email: type: string format: email description: Email address of the contact example: jane.doe@example.com metadata: type: array items: type: object additionalProperties: {} description: >- A hash of key/value pairs containing any other data about the contact example: - department: Engineering role: Senior Developer logo_url: type: string description: URL to the contact's avatar or logo example: https://example.com/avatars/jane-doe.jpg tags: type: array items: type: string description: A list of tags associated with the contact example: - hr - engineering required: - id description: >- @deprecated Use identity instead. Information about the contact making the request. deprecated: true securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````