openapi: 3.2.0
info:
  title: Photoshop API documentation Lightroom API
  description: API Documentation
  version: '1.0'
servers:
- url: https://image.adobe.io
security: []
tags:
- name: Lightroom
paths:
  /lrService/autoStraighten:
    post:
      tags:
      - Lightroom
      summary: Auto straighten an image
      description: "Initiates an asynchronous job to auto straighten an image. \\\nTo get status of this job, call [Status API](./#operation/acrstatus).\\\n To know more about this feature refer [AutoStraighten](../features/#autoStraighten)"
      operationId: autoStraighten
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./acr/post_auto_straighten.schema.json
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/api_response_success_schema.json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ./api_response_400_error_schema.json
        '402':
          description: Trial Limit Exceeded
          content:
            application/json:
              schema:
                $ref: ./api_response_402_error_schema.json
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: ./api_response_403_error_schema.json
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: ./api_response_404_error_schema.json
        '409':
          description: File Overwrite Error
          content:
            application/json:
              schema:
                $ref: ./api_response_409_error_schema.json
        '410':
          description: Asset Link Invalid
          content:
            application/json:
              schema:
                $ref: ./api_response_410_error_schema.json
        '500':
          description: Internal Server Error
      x-codeSamples:
      - lang: shell
        source: "curl --request POST \\\n  --url https://image.adobe.io/lrService/autoStraighten \\\n  --header 'Authorization: Bearer $token' \\\n  --header 'content-type: application/json' \\\n  --header 'x-api-key: $x-api-key' \\\n  --data '{\"inputs\":{\"href\":\"string\",\"storage\":\"external\"},\\\n\"options\":{\"uprightMode\":\"full\",\"constrainCrop\":false},\"outputs\":[{\"href\":\"string\",\"storage\":\"external\",\"type\":\"image/jpeg\"}]}'"
  /lrService/autoTone:
    post:
      tags:
      - Lightroom
      summary: Auto tone an image
      description: "Initiates an asynchronous job to auto tone an image.\nTo get status of this job, call [Status API](./#operation/acrstatus).\\\n To know more about this feature refer [AutoTone](../features/#autotone)"
      operationId: autoTone
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./acr/post_auto_tone.schema.json
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/api_response_success_schema.json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ./api_response_400_error_schema.json
        '402':
          description: Trial Limit Exceeded
          content:
            application/json:
              schema:
                $ref: ./api_response_402_error_schema.json
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: ./api_response_403_error_schema.json
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: ./api_response_404_error_schema.json
        '409':
          description: File Overwrite Error
          content:
            application/json:
              schema:
                $ref: ./api_response_409_error_schema.json
        '410':
          description: Asset Link Invalid
          content:
            application/json:
              schema:
                $ref: ./api_response_410_error_schema.json
        '500':
          description: Internal Server Error
      x-codeSamples:
      - lang: shell
        source: "curl --request POST \\\n  --url https://image.adobe.io/lrService/autoTone \\\n  --header 'Authorization: Bearer $token' \\\n  --header 'content-type: application/json' \\\n  --header 'x-api-key: $x-api-key' \\\n  --data '{\"inputs\":{\"href\":\"string\",\"storage\":\"external\"},\"outputs\":[{\"href\":\"string\",\"storage\":\"external\",\"type\":\"image/jpeg\"}]}'"
  /lrService/edit:
    post:
      tags:
      - Lightroom
      summary: Apply edits on an image
      description: "Initiates an asynchronous job to apply a set of edit parameters on an image.\nTo get status of this job, call [Status API](./#operation/acrstatus).\\\n To know more about this feature refer [Edit](../features/#edit)"
      operationId: edit
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./acr/post_image_edit.schema.json
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/api_response_success_schema.json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ./api_response_400_error_schema.json
        '402':
          description: Trial Limit Exceeded
          content:
            application/json:
              schema:
                $ref: ./api_response_402_error_schema.json
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: ./api_response_403_error_schema.json
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: ./api_response_404_error_schema.json
        '409':
          description: File Overwrite Error
          content:
            application/json:
              schema:
                $ref: ./api_response_409_error_schema.json
        '410':
          description: Asset Link Invalid
          content:
            application/json:
              schema:
                $ref: ./api_response_410_error_schema.json
        '500':
          description: Internal Server Error
      x-codeSamples:
      - lang: shell
        source: "curl --request POST \\\n  --url https://image.adobe.io/lrService/edit \\\n  --header 'Authorization: Bearer $token' \\\n  --header 'content-type: application/json' \\\n  --header 'x-api-key: $x-api-key' \\\n  --data '{\"inputs\": {\"source\": {\"href\":\"string\",\"storage\":\"external\"}, \\\n\"options\": \"<options>\"},\"outputs\":[{\"href\":\"string\",\"storage\":\"external\",\"type\":\"type\"}]}'"
  /lrService/presets:
    post:
      tags:
      - Lightroom
      summary: Apply a presets on an image
      description: "Initiates an asynchronous job to apply a preset on an image.\nTo get status of this job, call [Status API](./#operation/acrstatus).\\\n To know more about this feature refer [Presets](../features/#presets)"
      operationId: presets
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./acr/post_presets.schema.json
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/api_response_success_schema.json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ./api_response_400_error_schema.json
        '402':
          description: Trial Limit Exceeded
          content:
            application/json:
              schema:
                $ref: ./api_response_402_error_schema.json
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: ./api_response_403_error_schema.json
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: ./api_response_404_error_schema.json
        '409':
          description: File Overwrite Error
          content:
            application/json:
              schema:
                $ref: ./api_response_409_error_schema.json
        '410':
          description: Asset Link Invalid
          content:
            application/json:
              schema:
                $ref: ./api_response_410_error_schema.json
        '500':
          description: Internal Server Error
      x-codeSamples:
      - lang: shell
        source: "curl --request POST \\\n  --url https://image.adobe.io/lrService/presets \\\n  --header 'Authorization: Bearer $token' \\\n  --header 'content-type: application/json' \\\n  --header 'x-api-key: $x-api-key' \\\n  --data '{\"inputs\": {\"source\": {\"href\":\"string\",\"storage\":\"external\"}, \\\n\"presets\": [{\"href\":\"string\",\"storage\":\"external\"}]},\"outputs\":[{\"href\":\"string\",\"storage\":\"external\",\"type\":\"type\"}]}'"
  /lrService/xmp:
    post:
      tags:
      - Lightroom
      summary: Apply xmp on an image
      description: "Initiates an asynchronous job to apply an XMP setting to an image.\nTo get status of this job, call [Status API](./#operation/acrstatus).\\\n To know more about this feature refer [XMP](../features/#xmp)"
      operationId: xmp
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: ./acr/post_xmp.schema.json
        required: true
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/api_response_success_schema.json
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: ./api_response_400_error_schema.json
        '402':
          description: Trial Limit Exceeded
          content:
            application/json:
              schema:
                $ref: ./api_response_402_error_schema.json
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: ./api_response_403_error_schema.json
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: ./api_response_404_error_schema.json
        '409':
          description: File Overwrite Error
          content:
            application/json:
              schema:
                $ref: ./api_response_409_error_schema.json
        '410':
          description: Asset Link Invalid
          content:
            application/json:
              schema:
                $ref: ./api_response_410_error_schema.json
        '500':
          description: Internal Server Error
      x-codeSamples:
      - lang: shell
        source: "curl --request POST \\\n  --url https://image.adobe.io/lrService/xmp \\\n  --header 'Authorization: Bearer $token' \\\n  --header 'content-type: application/json' \\\n  --header 'x-api-key: $x-api-key' \\\n  --data '{\"inputs\": {\"source\": {\"href\":\"string\",\"storage\":\"external\"}, \\\n\"options\": {\"xmp\":\"string\", \"orientation\":\"orientation\"},\"outputs\":[{\"href\":\"string\",\"storage\":\"external\",\"type\":\"type\"}]}'"
  /lrService/status/{jobId}:
    get:
      tags:
      - Lightroom
      summary: Get the status of a job
      description: Returns the status of a job. Please expand `200 Successful operation` under `Responses` to know details of the status returned.
      operationId: acrstatus
      parameters:
      - name: Authorization
        description: 'Bearer: ${Authorization Token}'
        in: header
        required: true
        schema:
          type: string
      - name: x-api-key
        description: API key/client id
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        description: application/json
        in: header
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        description: IMS organization ID. This needs to be sent only if it is desirable to receive the job status through Adobe I/O Events.
        in: header
        required: false
        schema:
          type: string
      - name: jobId
        in: path
        description: The jobId to get status for.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: ./acr/get_status.schema.json