Quickstart

Get Started

Steps

  1. 1

    Authentication

    Request an API Key from the team

  2. 2

    Create a workflow

    Make a request to the create a workflow api endpoint

    API Request

    POST/workflow
    Properties
  3. 3

    Execute the workflow to create a job

    Make a request to the execute api endpoint

    API Request

    POST/workflow/{workflow_id}/job
    Properties
  4. 4

    Check the status of the job

    Make a request to the job status api endpoint. The job might required to be polled until it is completed

    API Request

    GETworkflow/{workflow_id}/job/{job_id}
    Properties