Actionpower Image API

openapi: 3.2.0
info:
  title: Cloud API 문서 Image API
  version: '1.0'
  description: 'API를 서비스를 사용하기 위해서는 JWT 토큰이 필요합니다.


    ## API Rate Limits


    각 API Endpoint 별 20 requests/sec 의 Rate Limit이 적용됩니다.


    이 허용치를 초과하는 요청량에 대해서는 HTTP 429 Too Many Request Error 응답이 나갈 수 있으며,


    반복, 지속적으로 요청량을 초과하게 되는 경우, 비정상적인 이용으로 간주되어 요청이 차단될 수 있습니다.'
  contact:
    name: Customer Service
    email: cs@daglo.ai
  termsOfService: https://daglo.ai/terms
  license:
    url: https://daglo.ai/license
    name: License
security:
- BearerAuth: []
tags:
- name: Image
paths:
  /image/v1/async/generate:
    x-permission: image-async
    post:
      x-descriptors:
      - default: default
      x-wait-for-response: false
      summary: Generate Images
      description: 이미지를 생성합니다.
      tags:
      - Image
      operationId: post-image-v1-async-generate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                imageConfig:
                  type: object
                  description: 비동기 방식의 이미지 생성 요청을 위한 설정입니다.
                  properties:
                    style:
                      type: string
                      description: 생성될 이미지의 스타일을 지정합니다.
                      enum:
                      - cartoon
                      - animation
                      - picture
                      - game
                      - 3d
                      - neon
                      - clay
                      - sketch
                      - pixelart
                      example: animation
                    description:
                      type: string
                      description: '생성하고자 하는 이미지에 대한 설명입니다.


                        <blockquote>


                        원본 이미지 없이 `description`으로 이미지를 생성할 때에는 반드시 기입해야 하는 값입니다.


                        </blockquote>'
                      example: 논밭길에 앉아있는 하얀 고양이
                    generate:
                      type: object
                      description: 이미지 생성 요청 관련 설정입니다.
                      properties:
                        num:
                          description: 생성될 이미지의 갯수입니다. 설정하지 않을 시 기본값은 1이며, 최대 4장까지 생성이 가능합니다.
                          type: integer
                          minimum: 1
                          maximum: 4
                          example: 4
                    size:
                      type: object
                      properties:
                        width:
                          type: integer
                          description: "생성할 이미지의 가로 크기 (px) 입니다. \n\n`image.source.url`이 주어졌을 경우, 기본값은 원본 이미지의 가로 크기이며, \n\n이미지가 따로 주어지지 않은 경우 기본값은 `1024` 입니다. "
                          minimum: 256
                          maximum: 2048
                        height:
                          type: integer
                          description: "생성할 이미지의 세로 크기 (px) 입니다. \n\n`image.source.url`이 주어졌을 경우, 기본값은 원본 이미지의 세로 크기이며, \n\n이미지가 따로 주어지지 않은 경우 기본값은 `1024` 입니다. "
                          minimum: 256
                          maximum: 2048
                  required:
                  - style
                image:
                  type: object
                  description: 원본 이미지를 기반으로 새로운 이미지를 생성하고자 할 경우 사용합니다.
                  properties:
                    source:
                      oneOf:
                      - type: object
                        title: UrlSourceImage
                        properties:
                          url:
                            type: string
                            description: 이미지의 URL 입니다. 공개적으로 접근 가능한 URL이어야 합니다.
                          type:
                            type: string
                            description: '원본 이미지의 종류입니다. 구체적인 종류를 명시하면 이미지 특성에 맞게 더 자연스러운 처리를 할 수 있습니다.


                              허용되는 값은 아래와 같습니다.


                              - `image`: (기본값) 일반적인 이미지 입니다.


                              - `doodle`: 낙서, 간단한 선그림을 통해 이미지를 생성하고자 할 때 사용합니다.'
                            enum:
                            - image
                            - doodle
                        required:
                        - url
                      - type: object
                        title: ByteSourceImage
                        properties:
                          content:
                            type: string
                            format: byte
                            description: Base64 인코딩된 이미지의 바이너리 데이터입니다.
                          type:
                            type: string
                            description: '원본 이미지의 종류입니다. 구체적인 종류를 명시하면 이미지 특성에 맞게 더 자연스러운 처리를 할 수 있습니다.


                              허용되는 값은 아래와 같습니다.


                              - `image`: (기본값) 일반적인 이미지 입니다.


                              - `doodle`: 낙서, 간단한 선그림을 통해 이미지를 생성하고자 할 때 사용합니다.'
                            enum:
                            - image
                            - doodle
                        required:
                        - content
                callback:
                  type: object
                  description: '비동기 요청의 진행 상태 및 결과를 콜백으로 전달 받고 싶을 때 사용합니다. '
                  properties:
                    url:
                      type: string
                      description: '콜백을 전송받을 http(s) 를 포함한 URL 입니다.


                        처리 중에는 진행상태를, 처리가 완료 된 뒤에는 결과 혹은 오류 상태를 `POST` 방식으로 해당 URL에 전송합니다.'
                    headers:
                      type: object
                      description: 콜백 URL로 전송할 때, 헤더에 포함시켜야 하는 값이 있다면 명시해줍니다.
                  x-tags:
                  - Common
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              required:
              - imageConfig
              x-tags:
              - Image
            examples:
              beach-animation:
                summary: An Example of Image Generation
                value:
                  imageConfig:
                    description: beach
                    style: animation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - Image
              examples:
                generate:
                  summary: An Example Response of Image Generation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000001
                mask:
                  summary: An Example Response of Image Mask Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000002
                transform:
                  summary: An Example Response of Image Transform Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000003
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: 너무 많은 요청을 처리하고 있어 일시적으로 응답이 불가능한 상태입니다. 잠시 후 다시 시도해주세요.
  /image/v1/async/mask:
    x-permission: image-async
    post:
      x-descriptors:
      - default: default
      x-wait-for-response: false
      summary: Edit Masked Area
      description: 이미지의 마스킹 영역을 수정합니다.
      tags:
      - Image
      operationId: post-image-v1-async-mask
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                image:
                  type: object
                  description: 이미지에 대한 정보입니다.
                  properties:
                    source:
                      description: 원본 이미지에 대한 정보입니다.
                      oneOf:
                      - type: object
                        title: UrlSourceImage
                        properties:
                          url:
                            type: string
                            description: 이미지의 URL 입니다. 공개적으로 접근 가능한 URL이어야 합니다.
                        required:
                        - url
                      - type: object
                        title: ByteSourceImage
                        properties:
                          content:
                            type: string
                            format: byte
                            description: Base64 인코딩된 이미지의 바이너리 데이터입니다.
                        required:
                        - content
                    mask:
                      description: 마스킹 영역이 표시된 이미지에 대한 정보입니다.
                      oneOf:
                      - type: object
                        title: UrlSourceImage
                        properties:
                          url:
                            type: string
                            description: 이미지의 URL 입니다. 공개적으로 접근 가능한 URL이어야 합니다.
                        required:
                        - url
                      - type: object
                        title: ByteSourceImage
                        properties:
                          content:
                            type: string
                            format: byte
                            description: Base64 인코딩된 이미지의 바이너리 데이터입니다.
                        required:
                        - content
                  required:
                  - source
                  - mask
                imageConfig:
                  type: object
                  description: 이미지의 마스킹 영역에 적용할 작업을 위한 설정입니다.
                  properties:
                    mask:
                      type: object
                      description: 이미지 마스킹 영역에 관련된 설정입니다.
                      properties:
                        mode:
                          type: string
                          description: 이미지 마스킹 영역에 적용할 작업입니다.
                          enum:
                          - replace
                          - remove
                      required:
                      - mode
                    description:
                      type: string
                      description: '이미지에 대한 설명입니다. `imageConfig.mask.mode` 값이 `replace`인 경우에 필수로 설정해야 합니다. '
                      example: sky
                    style:
                      type: string
                      description: 그림에 적용할 스타일과 관련된 설정입니다. `imageConfig.mask.mode` 값이 `remove`인 경우 적용되지 않습니다.
                      enum:
                      - cartoon
                      - animation
                      - picture
                      - game
                      - 3d
                      - neon
                      - clay
                      - sketch
                      - pixelart
                      - yoontaeho
                      example: animation
                  required:
                  - mask
                callback:
                  type: object
                  description: '비동기 요청의 진행 상태 및 결과를 콜백으로 전달 받고 싶을 때 사용합니다. '
                  properties:
                    url:
                      type: string
                      description: '콜백을 전송받을 http(s) 를 포함한 URL 입니다.


                        처리 중에는 진행상태를, 처리가 완료 된 뒤에는 결과 혹은 오류 상태를 `POST` 방식으로 해당 URL에 전송합니다.'
                    headers:
                      type: object
                      description: 콜백 URL로 전송할 때, 헤더에 포함시켜야 하는 값이 있다면 명시해줍니다.
                  x-tags:
                  - Common
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              required:
              - image
              - imageConfig
              x-tags:
              - Image
            examples:
              mask:
                summary: An Example of Image Mask Operation
                value:
                  image:
                    source:
                      url: https://storage.googleapis.com/bkt-ap-mybrownie-samples/example-beach-animation.png
                    mask:
                      url: https://storage.googleapis.com/bkt-ap-mybrownie-samples/example-beach-animation-mask.png
                  imageConfig:
                    mask:
                      mode: remove
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - Image
              examples:
                generate:
                  summary: An Example Response of Image Generation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000001
                mask:
                  summary: An Example Response of Image Mask Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000002
                transform:
                  summary: An Example Response of Image Transform Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000003
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: 너무 많은 요청을 처리하고 있어 일시적으로 응답이 불가능한 상태입니다. 잠시 후 다시 시도해주세요.
  /image/v1/async/transform:
    x-permission: image-async
    post:
      x-descriptors:
      - default: default
      x-wait-for-response: false
      summary: Transform Image
      description: 이미지를 변환합니다.
      tags:
      - Image
      operationId: post-image-v1-async-transform
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                image:
                  type: object
                  description: 이미지에 대한 정보입니다.
                  properties:
                    source:
                      description: 이미지에 대한 정보입니다.
                      oneOf:
                      - type: object
                        title: UrlSourceImage
                        properties:
                          url:
                            type: string
                            description: 이미지의 URL 입니다. 공개적으로 접근 가능한 URL이어야 합니다.
                        required:
                        - url
                      - type: object
                        title: ByteSourceImage
                        properties:
                          content:
                            type: string
                            format: byte
                            description: Base64 인코딩된 이미지의 바이너리 데이터입니다.
                        required:
                        - content
                  required:
                  - source
                imageConfig:
                  type: object
                  description: 이미지 변환을 위한 설정입니다.
                  properties:
                    transform:
                      type: object
                      description: 이미지 변환 작업에 관련된 설정입니다.
                      properties:
                        filter:
                          type: object
                          description: 이미지 변환에 적용할 효과입니다.
                          properties:
                            name:
                              type: string
                              enum:
                              - sketch
                              - clean-sketch
                          required:
                          - name
                      required:
                      - filter
                  required:
                  - transform
                callback:
                  type: object
                  description: '비동기 요청의 진행 상태 및 결과를 콜백으로 전달 받고 싶을 때 사용합니다. '
                  properties:
                    url:
                      type: string
                      description: '콜백을 전송받을 http(s) 를 포함한 URL 입니다.


                        처리 중에는 진행상태를, 처리가 완료 된 뒤에는 결과 혹은 오류 상태를 `POST` 방식으로 해당 URL에 전송합니다.'
                    headers:
                      type: object
                      description: 콜백 URL로 전송할 때, 헤더에 포함시켜야 하는 값이 있다면 명시해줍니다.
                  x-tags:
                  - Common
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              x-tags:
              - Image
              required:
              - image
              - imageConfig
            examples:
              transform:
                summary: An Example of Image Transform Operation
                value:
                  image:
                    source:
                      url: https://storage.googleapis.com/bkt-ap-mybrownie-samples/example-beach-animation.png
                  imageConfig:
                    transform:
                      filter:
                        name: clean-sketch
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - Image
              examples:
                generate:
                  summary: An Example Response of Image Generation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000001
                mask:
                  summary: An Example Response of Image Mask Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000002
                transform:
                  summary: An Example Response of Image Transform Operation
                  value:
                    rid: 01234567-1234-4567-89ab-000000000003
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: 너무 많은 요청을 처리하고 있어 일시적으로 응답이 불가능한 상태입니다. 잠시 후 다시 시도해주세요.
  /image/v1/async/results/{rid}:
    x-permission: image-async
    get:
      summary: Get Processed Images
      description: 이미지 프로세싱 결과를 가져옵니다.
      tags:
      - Image
      operationId: get-image-v1-async-rid
      parameters:
      - examples:
          generate:
            summary: Example for getting image generation result
            value: 01234567-1234-4567-89ab-000000000001
          mask:
            summary: Example 

# --- truncated at 32 KB (175 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/actionpower/refs/heads/main/openapi/actionpower-image-api-openapi.yml