Adobe Suite Manage jobs API

openapi: 3.2.0
info:
  title: Adobe Suite Manage jobs API
  version: '1.0'
  description: 'Operations tagged Manage jobs across 2 of this provider''s published API definitions: adobe-suite-firefly-audio-video-openapi.json, adobe-suite-firefly-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://audio-video-api.adobe.io
  description: Production server.
- url: https://firefly-api.adobe.io
  description: Production server.
security:
- AccessToken: []
  X-Api-Key: []
tags:
- name: Manage jobs
  description: Endpoints for managing asynchronous jobs.
paths:
  /v1/status/{jobId}:
    get:
      tags:
      - Manage jobs
      summary: Get job status
      description: Provides the status and result of an asynchronous job. For Dynamic Graphics Render (DGR), returns the status of a Describe template or Render job.
      operationId: status
      parameters:
      - name: jobId
        in: path
        description: The job ID of an asynchronous job.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusAPIResponse'
              examples:
                StatusAPIInprogressRequestResponse:
                  $ref: '#/components/examples/StatusApiInProgressRequestResponse'
                StatusAPISuccessRequestResponse:
                  $ref: '#/components/examples/StatusApiSuccessRequestResponse'
                StatusAPIFailedInputFileDownloadResponse:
                  $ref: '#/components/examples/StatusAPIFailedInputFileDownloadResponse'
                DGRJobStatusNotStarted:
                  $ref: '#/components/examples/DGRJobStatusNotStarted'
                DGRJobStatusRunning:
                  $ref: '#/components/examples/DGRJobStatusRunning'
                DGRDescribeSuccess:
                  $ref: '#/components/examples/DGRDescribeSuccess'
                DGRDescribeAEPSuccess:
                  $ref: '#/components/examples/DGRDescribeAEPSuccess'
                DGRRenderSuccessSingle:
                  $ref: '#/components/examples/DGRRenderSuccessSingle'
                DGRRenderSuccessMultiple:
                  $ref: '#/components/examples/DGRRenderSuccessMultiple'
                DGRRenderPartialSuccess:
                  $ref: '#/components/examples/DGRRenderPartialSuccess'
                DGRRenderSuccessTwoVariations:
                  $ref: '#/components/examples/DGRRenderSuccessTwoVariations'
                DGRJobFailed:
                  $ref: '#/components/examples/DGRJobFailed'
                DGRJobCanceled:
                  $ref: '#/components/examples/DGRJobCanceled'
                StatusAPIFailedMediatypeMismatchResponse:
                  $ref: '#/components/examples/StatusAPIFailedMediatypeMismatchResponse'
                StatusAPIFailedCAISigningResponse:
                  $ref: '#/components/examples/StatusAPIFailedCAISigningResponse'
                StatusAPIFailedUploadErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedUploadErrorResponse'
                StatusAPIFailedDownloadErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedDownloadErrorResponse'
                StatusAPIFailedTTSErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedTTSErrorResponse'
                StatusAPIFailedDurationTooLongResponse:
                  $ref: '#/components/examples/StatusAPIFailedDurationTooLongResponse'
                StatusAPIFailedUnsupportedBackgroundResponse:
                  $ref: '#/components/examples/StatusAPIFailedUnsupportedBackgroundResponse'
                StatusAPIFailedBackgroundResolutionErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedBackgroundResolutionErrorResponse'
                StatusAPIFailedCropAreaErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedCropAreaErrorResponse'
                StatusAPIFailedBackgroundCropErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedBackgroundCropErrorResponse'
                StatusAPIFailedFFMpegErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedFFMpegErrorResponse'
                StatusAPIFailedAvatarErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedAvatarErrorResponse'
                StatusAPIFailedLipsyncErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedLipsyncErrorResponse'
                StatusAPIFailedLipsyncPollingErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedLipsyncPollingErrorResponse'
                StatusAPIFailedMediaTrimErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedMediaTrimErrorResponse'
                StatusAPIFailedMediaTrimAlphaErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedMediaTrimAlphaErrorResponse'
                StatusAPIFailedInternalErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedInternalErrorResponse'
                StatusAPIFailedTTSInternalErrorResponse:
                  $ref: '#/components/examples/StatusAPIFailedTTSInternalErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
              examples:
                ErrorBodyUnauthorized:
                  $ref: '#/components/examples/ErrorBodyUnauthorized'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
              examples:
                ErrorBodyForbidden:
                  $ref: '#/components/examples/ErrorBodyForbidden'
                ErrorBodyAPIKeyInvalid:
                  $ref: '#/components/examples/ErrorBodyAPIKeyInvalid'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
              examples:
                ErrorBodyResourceNotFound:
                  $ref: '#/components/examples/ErrorBodyResourceNotFound'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
              examples:
                ErrorBodyTooManyRequests:
                  $ref: '#/components/examples/ErrorBodyTooManyRequests'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
              examples:
                RunTimeError:
                  $ref: '#/components/examples/RunTimeError'
                TEXT_TO_SPEECH_ENTITY_CREATION_ERROR:
                  $ref: '#/components/examples/TEXT_TO_SPEECH_ENTITY_CREATION_ERROR'
                TEXT_TO_SPEECH_SERVICE_SUBMIT_ERROR:
                  $ref: '#/components/examples/TEXT_TO_SPEECH_SERVICE_SUBMIT_ERROR'
    servers:
    - url: https://audio-video-api.adobe.io
      description: Production server.
  /v1/cancel/{jobId}:
    put:
      tags:
      - Manage jobs
      summary: Cancel a render job
      description: 'Aborts an in-flight render job. Returns `202 Accepted` as soon as the cancellation has been accepted; subsequent calls to `GET /v1/status/{jobId}` will report `"status": "canceled"` once the worker has fully stopped the underlying render.


        **Applicable only to render jobs submitted via `POST /v1/templates/render`.** This endpoint does not apply to Describe, Reframe, TLS, TTS, or Avatar jobs.


        **Notes:**

        - Cancellation is idempotent.

        - Once propagated to the worker, in-progress outputs are not uploaded to the destinations specified in the original render request.

        - For a short window after the PUT, the status endpoint may still report `running`; poll until it transitions to `canceled`.'
      operationId: cancel-render-job
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: UUID of the render job to cancel, as returned in the `jobId` field of the original 202 submit response or in the `cancelUrl` property of a List Render Jobs response item.
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        '202':
          description: Cancellation accepted. The job is transitioning to `canceled`; poll `GET /v1/status/{jobId}` to observe the terminal state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelAcceptedResponse'
              examples:
                CancelAccepted:
                  $ref: '#/components/examples/CancelAccepted'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidJsonError:
                  value:
                    error_code: invalid_json
                    message: Invalid request. Please check the input data.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidToken:
                  value:
                    error_code: '401013'
                    message: OAuth token is not valid.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidContext:
                  value:
                    error_code: access_error
                    message: Token not allowed in the current context.
        '404':
          description: Not Found — `jobId` is unknown or no longer accessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JobNotFound:
                  $ref: '#/components/examples/CancelJobNotFound'
        '409':
          description: Conflict — the job is already in a terminal state and cannot be canceled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                JobAlreadyCompleted:
                  $ref: '#/components/examples/CancelJobAlreadyCompleted'
                JobAlreadyCanceled:
                  $ref: '#/components/examples/CancelJobAlreadyCanceled'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RateLimited:
                  value:
                    error_code: rate_limit_exceeded
                    message: Too many requests. Please retry after some time.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  value:
                    error_code: runtime_error
                    message: Internal Server Error
                    messageId: '50005001'
    servers:
    - url: https://audio-video-api.adobe.io
      description: Production server.
  /v1/templates/render-jobs:
    get:
      tags:
      - Manage jobs
      summary: List render jobs
      description: 'Returns a paginated list of template render jobs owned by the authenticated caller, optionally filtered by status and creation date.


        **Applicable only to render jobs submitted via `POST /v1/templates/render`.** Jobs from other API types (Describe, Reframe, TLS, TTS, Avatar) are not returned.


        **Filter syntax (FIQL):**

        - `status==running` — single status equality

        - `status=in=(running,not_started)` — status set membership

        - `createdDate=ge=2026-05-01T00:00:00Z` — absolute ISO 8601 lower bound

        - `createdDate=ge=-P7D` — relative ISO 8601 duration (last 7 days)

        - Combine with `;` (AND): `status==running;createdDate=ge=-P7D`


        **Default filter:** all statuses, `createdDate` within the last 30 days.


        **Retention:** `createdDate` filter values must fall within the 30-day retention window.


        **Pagination:** follow `paging.nextUrl` until it is absent (last page).'
      operationId: list-render-jobs
      parameters:
      - name: filter
        in: query
        required: false
        description: 'FIQL filter string. Supported sub-params: `status` (enum) and `createdDate` (ISO 8601 date-time or relative duration). Default: `createdDate=ge=-P30D;status=in=(not_started,running,succeeded,partially_succeeded,failed,canceled)`.'
        schema:
          type: string
        examples:
          RunningOnly:
            summary: Running jobs only
            value: status==running
          Last7DaysRunning:
            summary: Running jobs in last 7 days
            value: createdDate=ge=-P7D;status==running
          AbsoluteDateRange:
            summary: Absolute date range
            value: createdDate=ge=2026-05-14T00:00:00Z;createdDate=le=2026-05-21T00:00:00Z
          MultipleStatuses:
            summary: Multiple statuses
            value: status=in=(running,not_started)
      - name: limit
        in: query
        required: false
        description: Maximum number of job entries to return per page. Must be between 1 and 100 (inclusive). Defaults to 20.
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: cursor
        in: query
        required: false
        description: Opaque pagination cursor returned in `paging.nextUrl` of a previous response. Omit to fetch the first page.
        schema:
          type: string
      - $ref: '#/components/parameters/XRequestIdHeader'
      responses:
        '200':
          description: Success — list of render jobs (may be empty).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderJobListResponse'
              examples:
                FirstPageWithMore:
                  $ref: '#/components/examples/RenderJobListFirstPage'
                LastPage:
                  $ref: '#/components/examples/RenderJobListLastPage'
                EmptyResult:
                  $ref: '#/components/examples/RenderJobListEmpty'
        '400':
          description: Bad request — invalid filter, limit, cursor, or date range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidStatusFilter:
                  $ref: '#/components/examples/ListJobsInvalidStatusFilter'
                LimitOutOfRange:
                  $ref: '#/components/examples/ListJobsLimitOutOfRange'
                InvalidCursor:
                  $ref: '#/components/examples/ListJobsInvalidCursor'
                InvalidFilter:
                  $ref: '#/components/examples/ListJobsInvalidFilter'
                FilterOutOfRetention:
                  $ref: '#/components/examples/ListJobsFilterOutOfRetention'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidToken:
                  value:
                    error_code: '401013'
                    message: OAuth token is not valid.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidContext:
                  value:
                    error_code: access_error
                    message: Token not allowed in the current context.
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RateLimited:
                  value:
                    error_code: rate_limit_exceeded
                    message: Too many requests. Please retry after some time.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  value:
                    error_code: runtime_error
                    message: Internal Server Error
                    messageId: '50005001'
    servers:
    - url: https://audio-video-api.adobe.io
      description: Production server.
  /v2/status/{jobId}:
    get:
      tags:
      - Manage jobs
      summary: Get job result
      description: This endpoint retrieves the result of an asynchronous reframed job initiated using the job ID.
      operationId: job-result-v2
      parameters:
      - name: jobId
        in: path
        description: The job ID to get status for an asynchronous generate reframed video job.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: Job response on status API.
                oneOf:
                - title: Job In Progress
                  type: object
                  description: Response indicating that the reframed video job is in progress.
                  properties:
                    status:
                      type: string
                      enum:
                      - not_started
                      - running
                      - failed
                      - succeeded
                      - partially_succeeded
                      description: The status of the reframed video job.
                    jobId:
                      type: string
                      description: The unique identifier for the job.
                  required:
                  - status
                  - jobId
                - title: Job Success
                  type: object
                  description: Success response for the reframed video job.
                  properties:
                    status:
                      type: string
                      enum:
                      - not_started
                      - running
                      - failed
                      - succeeded
                      - partially_succeeded
                      description: The status of the reframed video job.
                    jobId:
                      type: string
                      description: The unique identifier for the job.
                    outputs:
                      type: array
                      uniqueItems: true
                      description: Array of output rendition results.
                      items:
                        oneOf:
                        - title: Successful Rendition
                          type: object
                          properties:
                            destination:
                              type: object
                              properties:
                                url:
                                  type: string
                                  format: uri
                                  description: The pre-signed URL pointing to the output.
                              required:
                              - url
                              description: Details of the output destination, including a pre-signed URL.
                          required:
                          - destination
                        - title: Failed Rendition
                          type: object
                          description: Error response for the generate reframed video job.
                          properties:
                            error:
                              type: object
                              properties:
                                error_code:
                                  type: string
                                  description: A code representing the specific error type.
                                message:
                                  type: string
                                  description: A description of the error that occurred.
                              required:
                              - message
                              - error_code
                              description: Details of the error encountered during the reframing process.
                          required:
                          - error
                  required:
                  - status
                  - jobId
                  - outputs
                - title: Job Partial Success
                  type: object
                  description: Response for a reframed video job that partially succeeded.
                  properties:
                    status:
                      type: string
                      enum:
                      - not_started
                      - running
                      - failed
                      - succeeded
                      - partially_succeeded
                      description: The status of the reframed video job.
                    jobId:
                      type: string
                      description: The unique identifier for the job.
                    outputs:
                      type: array
                      items:
                        oneOf:
                        - title: Successful Rendition
                          type: object
                          description: Success response for the generate reframed video job.
                          properties:
                            destination:
                              type: object
                              properties:
                                url:
                                  type: string
                                  format: uri
                                  description: The pre-signed URL pointing to the output.
                              required:
                              - url
                              description: Details of the output destination, including a pre-signed URL.
                          required:
                          - destination
                        - title: Failed Rendition
                          type: object
                          description: Error response for the generate reframed video job.
                          properties:
                            error:
                              type: object
                              properties:
                                error_code:
                                  type: string
                                  description: A code representing the specific error type.
                                message:
                                  type: string
                                  description: A description of the error that occurred.
                              required:
                              - message
                              - error_code
                              description: Details of the error encountered during the reframing process.
                          required:
                          - error
                      description: Details of the job's partial success, including successful outputs and any errors encountered.
                  required:
                  - status
                  - jobId
                  - outputs
                - title: Job Failure
                  type: object
                  description: Error response for a reframed video job that failed.
                  properties:
                    status:
                      type: string
                      enum:
                      - not_started
                      - running
                      - failed
                      - succeeded
                      - partially_succeeded
                      description: The status of the reframed video job, indicating a failure.
                    jobId:
                      type: string
                      description: The unique identifier for the job.
                    outputs:
                      type: object
                      properties:
                        renditions:
                          type: array
                          uniqueItems: true
                          description: Array of failed rendition outputs.
                          items:
                            title: Failed Rendition
                            type: object
                            description: Error response for the generate reframed video job.
                            properties:
                              error:
                                type: object
                                properties:
                                  error_code:
                                    type: string
                                    description: A code representing the specific error type.
                                  message:
                                    type: string
                                    description: A description of the error that occurred.
                                required:
                                - message
                                - error_code
                                description: Details of the error encountered during the reframing process.
                            required:
                            - error
                      required:
                      - renditions
                      description: Details of the errors encountered during the job.
                  required:
                  - status
                  - jobId
                  - outputs
              examples:
                GenerateReframedVideoJobPendingResponse:
                  summary: Job is pending
                  value:
                    status: pending
                    jobId: 123e4567-e89b-12d3-a456-426614174002
                GenerateReframedVideoJobInProgressResponse:
                  summary: Job is in progress
                  value:
                    status: running
                    jobId: 123e4567-e89b-12d3-a456-426614174002
                GenerateReframedVideoJobSuccessResponse:
                  summary: Job succeeded
                  value:
                    status: succeeded
                    jobId: 123e4567-e89b-12d3-a456-426614174002
                    outputs:
                    - destination:
                        url: <<<presigned download URL for reframed video file>>>
                GenerateReframedVideoJobPartialSuccessResponse:
                  summary: Job partially succeeded
                  value:
                    status: partially_succeeded
                    jobId: 123e4567-e89b-12d3-a456-426614174002
                    outputs:
                    - destination:
                        url: <<<presigned download URL for reframed video file>>>
                    - error:
                        error_code: <<error code from the list of defined error code in API Style>>
                        message: <<error message return by downstream service>>
                GenerateReframedVideoJobFailureResponse:
                  summary: Job failed
                  value:
                    status: failed
                    jobId: 123e4567-e89b-12d3-a456-426614174002
                    outputs:
                    - error:
                        error_code: <<error code from the list of defined error code in API Style>>
                        message: <<error message return by downstream service>>
                    - error:
                        error_code: <<error code from the list of defined error code in API Style>>
                        message: <<error message return by downstream service>>
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                description: Response indicating that the reframed video job has been successfully submitted.
                properties:
                  jobId:
                    type: string
                    description: The unique identifier for the job.
                  statusUrl:
                    type: string
                    description: The URL to monitor the status of the job.
                required:
                - jobId
                - statusUrl
                type: object
              examples:
                ErrorBodyBadRequest:
                  summary: Bad Request
                  value:
                    error_code: '400001'
                    message: Invalid request. Please check the input data.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                description: Response indicating that the reframed video job has been successfully submitted.
                properties:
                  jobId:
                    type: string
                    description: The unique identifier for the job.
                  statusUrl:
                    type: string
                    description: The URL to monitor the status of the job.
                required:
                - jobId
                - statusUrl
                type: object
              examples:
                ErrorBodyUnauthorized:
                  summary: Unauthorized
                  value:
                    error_code: '401013'
                    message: OAuth token is not valid
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                description: Response indicating that the reframed video job has been successfully submitted.
                properties:
                  jobId:
                    type: string
                    description: The unique identifier for the job.
                  statusUrl:
                    type: string
                    description: The URL to monitor the status of the job.
                required:
                - jobId
                - statusUrl
                type: object
              examples:
                ErrorBodyForbidden:
                  summary: Forbidden
                  value:
                    error_code: '401013'
                    message: OAuth token is not valid
        '404':
          description: Resource Not Found
          content:
            application/json:
              schema:
                description: Response indicating that the reframed video job has been successfully submitted.
                properties:
                  jobId:
                    type: string
                    description: The unique identifier for the job.
                  statusUrl:
                    type: string
                    description: The URL to monitor the status of the job.
                required:
                - jobId
                - statusUrl
                type: object
              examples:
                ErrorBodyResourceNotFound:
                  summary: Resource Not Found
                  value:
                    error_code: '404001'
                    message: The requested resource was not found.
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                description: Response indicating that the reframed video job has been successfully submitted.
                properties:
                  jobId:
                 

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-manage-jobs-api-openapi.yml