adobe-firefly-sdk
    Preparing search index...

    Type Alias JobResultV2Responses

    type JobResultV2Responses = {
        "200":
            | {
                jobId: string;
                status: | "not_started"
                | "running"
                | "failed"
                | "succeeded"
                | "partially_succeeded";
            }
            | {
                jobId: string;
                outputs: (
                    | { destination: { url: string } }
                    | { error: { error_code: string; message: string } }
                )[];
                status:
                    | "not_started"
                    | "running"
                    | "failed"
                    | "succeeded"
                    | "partially_succeeded";
            }
            | {
                jobId: string;
                outputs: (
                    | { destination: { url: string } }
                    | { error: { error_code: string; message: string } }
                )[];
                status:
                    | "not_started"
                    | "running"
                    | "failed"
                    | "succeeded"
                    | "partially_succeeded";
            }
            | {
                jobId: string;
                outputs: {
                    renditions: { error: { error_code: string; message: string } }[];
                };
                status: | "not_started"
                | "running"
                | "failed"
                | "succeeded"
                | "partially_succeeded";
            };
    }
    Index

    Properties

    Properties

    "200":
        | {
            jobId: string;
            status: | "not_started"
            | "running"
            | "failed"
            | "succeeded"
            | "partially_succeeded";
        }
        | {
            jobId: string;
            outputs: (
                | { destination: { url: string } }
                | { error: { error_code: string; message: string } }
            )[];
            status:
                | "not_started"
                | "running"
                | "failed"
                | "succeeded"
                | "partially_succeeded";
        }
        | {
            jobId: string;
            outputs: (
                | { destination: { url: string } }
                | { error: { error_code: string; message: string } }
            )[];
            status:
                | "not_started"
                | "running"
                | "failed"
                | "succeeded"
                | "partially_succeeded";
        }
        | {
            jobId: string;
            outputs: {
                renditions: { error: { error_code: string; message: string } }[];
            };
            status: | "not_started"
            | "running"
            | "failed"
            | "succeeded"
            | "partially_succeeded";
        }

    Job response on status API.

    Type Declaration

    • {
          jobId: string;
          status:
              | "not_started"
              | "running"
              | "failed"
              | "succeeded"
              | "partially_succeeded";
      }
      • jobId: string

        The unique identifier for the job.

      • status: "not_started" | "running" | "failed" | "succeeded" | "partially_succeeded"

        The status of the reframed video job.

    • {
          jobId: string;
          outputs: (
              | { destination: { url: string } }
              | { error: { error_code: string; message: string } }
          )[];
          status:
              | "not_started"
              | "running"
              | "failed"
              | "succeeded"
              | "partially_succeeded";
      }
      • jobId: string

        The unique identifier for the job.

      • outputs: (
            | { destination: { url: string } }
            | { error: { error_code: string; message: string } }
        )[]

        Array of output rendition results.

      • status: "not_started" | "running" | "failed" | "succeeded" | "partially_succeeded"

        The status of the reframed video job.

    • {
          jobId: string;
          outputs: (
              | { destination: { url: string } }
              | { error: { error_code: string; message: string } }
          )[];
          status:
              | "not_started"
              | "running"
              | "failed"
              | "succeeded"
              | "partially_succeeded";
      }
      • jobId: string

        The unique identifier for the job.

      • outputs: (
            | { destination: { url: string } }
            | { error: { error_code: string; message: string } }
        )[]

        Details of the job's partial success, including successful outputs and any errors encountered.

      • status: "not_started" | "running" | "failed" | "succeeded" | "partially_succeeded"

        The status of the reframed video job.

    • {
          jobId: string;
          outputs: {
              renditions: { error: { error_code: string; message: string } }[];
          };
          status: | "not_started"
          | "running"
          | "failed"
          | "succeeded"
          | "partially_succeeded";
      }
      • jobId: string

        The unique identifier for the job.

      • outputs: { renditions: { error: { error_code: string; message: string } }[] }

        Details of the errors encountered during the job.

        • renditions: { error: { error_code: string; message: string } }[]

          Array of failed rendition outputs.

      • status: "not_started" | "running" | "failed" | "succeeded" | "partially_succeeded"

        The status of the reframed video job, indicating a failure.