adobe-firefly-sdk
    Preparing search index...

    Type Alias GetDocumentInfoJobStatusData

    type GetDocumentInfoJobStatusData = {
        body?: never;
        headers: {
            Authorization: string;
            "x-api-key": string;
            "x-gw-ims-org-id"?: string;
        };
        path: { "document-info_job_id": string };
        query?: never;
        url: "/v3/status/{document-info_job_id}";
    }
    Index

    Properties

    body? headers path query? url

    Properties

    Optionalbody

    body?: never
    headers: {
        Authorization: string;
        "x-api-key": string;
        "x-gw-ims-org-id"?: string;
    }

    Type Declaration

    • Authorization: string

      The authorization token with bearer "token_value". For example: Bearer <access_token>.

    • x-api-key: string

      The API key as defined in Adobe's Developer Console.

    • Optionalx-gw-ims-org-id?: string

      This is the identifier for Adobe Identity Management Service (IMS) as defined in Adobe's Developer Console. This is optional.

    path: { "document-info_job_id": string }

    Type Declaration

    • document-info_job_id: string

      The ID of the Document Info job you want to see the status of. This comes from the response of the Document Info request.

    query?: never
    url: "/v3/status/{document-info_job_id}"

    Settings

    Member Visibility

    On This Page

    Properties