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

# Seedream 5.0 Pro - Edit image

> Edit images using ByteDance's Seedream 5.0 Pro model with text guidance.

**Key Features:**
- Preserves subject details, lighting, and color tone
- Supports up to 10 reference images
- Enhanced editing consistency
- Selectable resolution tiers (1.5K, 2K)

**Best for:**
- Image-to-image editing
- Style transfer with consistency
- Multi-image reference editing




## OpenAPI

````yaml post /v1/ai/text-to-image/seedream-v5-pro-edit
openapi: 3.0.0
info:
  description: >-
    The Magnific API is your gateway to a vast collection of high-quality
    digital resources for your applications and projects. As a leading platform,
    it offers a wide range of graphics, including vectors, photos,
    illustrations, icons, PSD templates, and more, all curated by talented
    designers from around the world.
  title: Magnific API
  version: 1.0.0
servers:
  - description: B2B API Production V1
    url: https://api.magnific.com
security:
  - magnificApiKey: []
paths:
  /v1/ai/text-to-image/seedream-v5-pro-edit:
    post:
      tags:
        - text-to-image
      summary: Seedream 5.0 Pro - Edit image
      description: |
        Edit images using ByteDance's Seedream 5.0 Pro model with text guidance.

        **Key Features:**
        - Preserves subject details, lighting, and color tone
        - Supports up to 10 reference images
        - Enhanced editing consistency
        - Selectable resolution tiers (1.5K, 2K)

        **Best for:**
        - Image-to-image editing
        - Style transfer with consistency
        - Multi-image reference editing
      operationId: create_image_edit_seedream_v5_pro
      requestBody:
        content:
          application/json:
            examples:
              required-params:
                $ref: >-
                  #/components/examples/request-seedream-v5-pro-edit-required-params
              all-params:
                $ref: '#/components/examples/request-seedream-v5-pro-edit-all-params'
            schema:
              $ref: '#/components/schemas/ttisdv5p-edit-request-content'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                success - in progress task:
                  $ref: '#/components/examples/200-task-in-progress'
              schema:
                $ref: >-
                  #/components/schemas/get_style_transfer_task_status_200_response
          description: >-
            OK - The request has succeeded and the Seedream 5.0 Pro edit process
            has started.
        '400':
          content:
            application/json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Parameter 'page' must be greater than 0
                invalid_query:
                  summary: Parameter 'query' is not valid
                  value:
                    message: Parameter 'query' must not be empty
                invalid_filter:
                  summary: Parameter 'filter' is not valid
                  value:
                    message: Parameter 'filter' is not valid
                generic_bad_request:
                  summary: Bad Request
                  value:
                    message: Parameter ':attribute' is not valid
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
            application/problem+json:
              examples:
                invalid_page:
                  summary: Parameter 'page' is not valid
                  value:
                    message: Validation error
                    invalid_params:
                      - field: page
                        reason: Parameter 'page' must be greater than 0
                      - field: per_page
                        reason: Parameter 'per_page' must be greater than 0
              schema:
                $ref: >-
                  #/components/schemas/get_all_style_transfer_tasks_400_response_1
          description: >-
            Bad Request - The server could not understand the request due to
            invalid syntax.
        '401':
          content:
            application/json:
              examples:
                invalid_api_key:
                  summary: API key is not valid
                  value:
                    message: Invalid API key
                missing_api_key:
                  summary: API key is not provided
                  value:
                    message: Missing API key
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_400_response'
          description: >-
            Unauthorized - The client must authenticate itself to get the
            requested response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_500_response'
          description: >-
            Internal Server Error - The server has encountered a situation it
            doesn't know how to handle.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_503_response'
          description: Service Unavailable
components:
  examples:
    request-seedream-v5-pro-edit-required-params:
      summary: Minimal request - Seedream 5.0 Pro Edit
      value:
        prompt: Make the background a snowy mountain landscape
        reference_images:
          - https://example.com/reference-image-1.jpg
    request-seedream-v5-pro-edit-all-params:
      summary: Complete request - Seedream 5.0 Pro Edit
      value:
        prompt: >-
          Make the background a snowy mountain landscape, keep the subject and
          lighting
        reference_images:
          - https://example.com/reference-image-1.jpg
          - https://example.com/reference-image-2.jpg
        resolution: 2k
        aspect_ratio: square_1_1
        seed: 12345
        webhook_url: https://your-app.com/webhooks/seedream-v5-pro-edit
    200-task-in-progress:
      summary: Success - Task in progress
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: IN_PROGRESS
  schemas:
    ttisdv5p-edit-request-content:
      allOf:
        - $ref: '#/components/schemas/ttisdv5p-request-content'
        - properties:
            reference_images:
              description: >
                Array of reference images for image editing (1 to 10 images).

                Seedream 5.0 Pro preserves subject details, lighting, and color
                tone when editing.


                **Supported formats:**

                - Base64-encoded image strings

                - Publicly accessible image URLs


                **Image requirements:**

                - Minimum resolution: 256x256 pixels

                - Maximum file size: 10MB per image

                - Supported formats: JPG, JPEG, PNG
              example:
                - https://example.com/reference-image-1.jpg
                - https://example.com/reference-image-2.jpg
              items:
                description: Image as Base64 encoded string or publicly accessible URL
                type: string
              maxItems: 10
              minItems: 1
              type: array
          required:
            - reference_images
          type: object
    get_style_transfer_task_status_200_response:
      example:
        data:
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
          generated:
            - https://openapi-generator.tech
            - https://openapi-generator.tech
      properties:
        data:
          $ref: '#/components/schemas/task-detail'
      required:
        - data
      type: object
    get_all_style_transfer_tasks_400_response:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    get_all_style_transfer_tasks_400_response_1:
      properties:
        problem:
          $ref: >-
            #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem
      type: object
    get_all_style_transfer_tasks_500_response:
      example:
        message: Internal Server Error
      properties:
        message:
          example: Internal Server Error
          type: string
      type: object
    get_all_style_transfer_tasks_503_response:
      example:
        message: Service Unavailable. Please try again later.
      properties:
        message:
          example: Service Unavailable. Please try again later.
          type: string
      type: object
    ttisdv5p-request-content:
      properties:
        prompt:
          description: >
            Text description of the image you want to generate.


            **Tips:**

            - Be specific about visual details, composition, and style

            - Seedream 5.0 Pro delivers high-fidelity detail, strong prompt
            adherence, and superior composition

            - Describe lighting, atmosphere, and camera angles for best results


            **Examples:**

            - Simple: "A futuristic cityscape at sunset with neon lights"

            - Detailed: "A futuristic cityscape at sunset with neon lights,
            detailed architecture, volumetric lighting, cinematic composition"
          example: A futuristic cityscape at sunset with neon lights
          maxLength: 4096
          type: string
        webhook_url:
          description: >
            Optional callback URL that will receive asynchronous notifications
            whenever the task changes status. The payload sent to this URL is
            the same as the corresponding GET endpoint response, but without the
            data field.
          example: https://www.example.com/webhook
          format: uri
          type: string
        resolution:
          default: 2k
          description: >
            Output resolution tier.


            Available options:

            - `2k`: Base output - up to ~4.19M pixels (2048x2048 at 1:1)

            - `1.5k`: Economical tier - capped at ~2.36M pixels (1536x1536 at
            1:1)


            The final image dimensions fit the selected aspect ratio within the
            tier's

            pixel budget, with each dimension rounded to a multiple of 16.
          enum:
            - 1.5k
            - 2k
          example: 2k
          type: string
        aspect_ratio:
          default: square_1_1
          description: >
            The aspect ratio of the generated image, combined with the
            resolution tier to compute the final dimensions.


            Available options:

            - `square_1_1`: Square format - Instagram feed, profile pictures

            - `widescreen_16_9`: Landscape - YouTube thumbnails, presentations

            - `social_story_9_16`: Portrait - TikTok, Instagram Stories

            - `portrait_2_3`: Tall portrait - Pinterest pins

            - `traditional_3_4`: Classic photo - Traditional photography

            - `standard_3_2`: Photo print - Standard prints

            - `classic_4_3`: Monitor ratio - Classic displays

            - `cinematic_21_9`: Ultra-wide - Cinematic banners
          enum:
            - square_1_1
            - widescreen_16_9
            - social_story_9_16
            - portrait_2_3
            - traditional_3_4
            - standard_3_2
            - classic_4_3
            - cinematic_21_9
          example: square_1_1
          type: string
        seed:
          description: >
            Random seed for reproducibility.

            Using the same seed with identical parameters produces similar
            results.

            Useful for iterating on a design or creating variations.
          example: 12345
          maximum: 4294967295
          minimum: 0
          type: integer
      required:
        - prompt
      type: object
    task-detail:
      allOf:
        - $ref: '#/components/schemas/task'
        - properties:
            generated:
              items:
                description: URL of the generated image
                format: uri
                type: string
              type: array
          required:
            - generated
          type: object
      example:
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
        generated:
          - https://openapi-generator.tech
          - https://openapi-generator.tech
    get_all_style_transfer_tasks_400_response_1_problem:
      properties:
        message:
          example: Validation error
          type: string
        invalid_params:
          items:
            $ref: >-
              #/components/schemas/get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner
          type: array
      required:
        - invalid_params
        - message
      type: object
    task:
      example:
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
      properties:
        task_id:
          description: Task identifier
          format: uuid
          type: string
        status:
          description: Task status
          enum:
            - CREATED
            - IN_PROGRESS
            - COMPLETED
            - FAILED
          type: string
      required:
        - status
        - task_id
      type: object
    get_all_style_transfer_tasks_400_response_1_problem_invalid_params_inner:
      properties:
        name:
          description: Name of the invalid parameter.
          example: page
          type: string
        field:
          description: Field of the invalid parameter. Mirrors `name`.
          example: page
          type: string
        reason:
          example: Parameter 'page' must be greater than 0
          type: string
      required:
        - field
        - name
        - reason
      type: object
  securitySchemes:
    magnificApiKey:
      description: >
        Your Magnific API key. Required for authentication. [Learn how to obtain
        an API key](https://docs.magnific.com/quickstart)
      in: header
      name: x-magnific-api-key
      type: apiKey

````