> ## Documentation Index
> Fetch the complete documentation index at: https://docs.intelligence-management-platform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit images

> Edits one or more reference images using a text prompt and uploads the results to S3. Reference image keys must belong to the calling user's S3 folder or the session's images prefix — the backend enforces this with a prefix check. An optional mask image key may be provided for inpainting. The chosen model must support editing (`supports_edit: true` in `config.litellm.yaml`).



## OpenAPI

````yaml /openapi/openapi.json post /images/edit
openapi: 3.1.0
info:
  title: IMP REST API
  version: 1.0.0
  description: >-
    REST endpoints of the IMP backend. GraphQL covers entity CRUD; REST covers
    agent runs, media, files, and system utilities. All requests require
    authentication unless the agent is public.
servers:
  - url: '{baseUrl}'
    variables:
      baseUrl:
        default: http://localhost:9001
        description: >-
          Base URL of your IMP backend. Self-hosted deployments typically run on
          port 9001.
security:
  - apiKey: []
  - bearer: []
tags:
  - name: Agents
    description: Endpoints for running, compacting, and querying agent instances.
  - name: Sessions
    description: Endpoints for managing files attached to agent sessions.
  - name: Media
    description: Transcription, speech synthesis, and image generation.
  - name: System
    description: Platform health and configuration utilities.
  - name: Budgets
    description: >-
      LiteLLM tag-budget management for users, roles, teams, projects, agents,
      and routines. Access requires `super_admin` or a role with
      `budget_management` write scope.
  - name: Skills
    description: >-
      Skills are versioned bundles of files (markdown, scripts, assets) mounted
      into the agent sandbox. These endpoints manage the skill registry and
      individual skill files.
  - name: Uploads
    description: >-
      Uppy-compatible S3 companion routes for single-part and multipart file
      uploads. Accept the standard API key. The `internal-key` header (set to
      `INTERNAL_SECRET`) is accepted only on `/s3/delete`, `/s3/download`,
      `/s3/list`, and `/s3/object` — it does **not** work on `/s3/sign` or the
      `/s3/multipart` routes.
  - name: Compliance
    description: >-
      GDPR / DSGVO operator endpoints for data-subject access (export) and
      erasure. Both require `super_admin`.
  - name: Artifacts
    description: >-
      Shareable artifact links — create, list, and revoke share links for files
      stored in S3.
paths:
  /images/edit:
    post:
      tags:
        - Media
      summary: Edit images
      description: >-
        Edits one or more reference images using a text prompt and uploads the
        results to S3. Reference image keys must belong to the calling user's S3
        folder or the session's images prefix — the backend enforces this with a
        prefix check. An optional mask image key may be provided for inpainting.
        The chosen model must support editing (`supports_edit: true` in
        `config.litellm.yaml`).
      operationId: editImage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - sessionId
                - toolCallId
                - model
                - prompt
                - referenceImageKeys
              properties:
                sessionId:
                  type: string
                  format: uuid
                toolCallId:
                  type: string
                model:
                  type: string
                  description: Image-generation model that supports editing.
                prompt:
                  type: string
                referenceImageKeys:
                  type: array
                  minItems: 1
                  items:
                    type: string
                  description: >-
                    S3 keys of the source images. Must belong to the session or
                    calling user's prefix.
                maskKey:
                  type: string
                  description: Optional S3 key of a mask image for inpainting.
                'n':
                  type: integer
                  minimum: 1
                size:
                  type: string
                quality:
                  type: string
                styleId:
                  type: string
      responses:
        '200':
          description: Edited images.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generationId:
                    type: string
                  images:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        presignedUrl:
                          type: string
                        revisedPrompt:
                          type:
                            - string
                            - 'null'
        '400':
          description: >-
            Missing fields, model does not support editing, or invalid
            parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Caller lacks write access to the session or a reference/mask key is
            inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Session not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Image generation not enabled or service not ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
        message:
          type: string
          description: Human-readable error message (alternate key used on some endpoints).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Organisation API key. Format: `sk_<secret>/<keyname>` — the secret
        portion, a literal slash, and the human-readable key name. The header
        `exulu-api-key` is accepted as an alias. A `Bearer ` prefix is tolerated
        and stripped. Keys with an agent scope are only valid for the scoped
        agent instance.
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        NextAuth session JWT (HS256, signed with `NEXTAUTH_SECRET`). This is the
        token the IMP frontend uses automatically.

````