ADadobe
Custom Scripts

Submit a custom script execution request

Changed on

Submits execution requests for custom scripts. Defines input assets and parameters that the custom script will use during execution.

post/v3/{ownerHash}/{capabilityName}

Request

  • Base URL
    https://illustrator-api.adobe.io
  • URL
    https://illustrator-api.adobe.io/v3/{ownerHash}/{capabilityName}
  • Auth
    HTTP bearer and API key in header x-api-key

Path parameters

ownerHashstring required

Path segment for the script owner (owner hash), as in the url returned in the custom script Submit a Custom Script response (same role as a script scope identifier in other Custom Scripts products).

capabilityNamestring required

The name of the custom script, specified in the custom script manifest.json and registration response (same idea as a script name in custom script manifest-based APIs).

Request body

Example request

{
  "assets": [
    {
      "source": {
        "url": "<presigned-url>"
      }
    }
  ]
}

Response

Accepted

jobIdstring required

Job identifier. Use with Retrieve job status on GET /v3/status/{jobId} for Custom Scripts jobs.

statusUrlstring required

URL to poll for job status.

Example response

{
  "jobId": "string",
  "statusUrl": "string"
}

Changes