Skip to main content
    Ivy Biosciences Docs/Call the platform/API/REST API/Batch Jobs

    Batch Jobs

    Submit up to 100 jobs in one POST, each with its own jobType and parameters, then read up to 200 of them per status call — batch-enabled tools only.

    restbatchparallel

    The Batch Jobs API submits many jobs in one request. Reach for it when you'd otherwise loop the Jobs API over a list of inputs: each entry in jobs[] carries its own jobType and parameters, and the route records every entry as its own job.

    Difficulty

    intermediate

    Time

    10 min

    Batch Jobs API

    Submit up to 100 jobs in one request. Each entry names its own tool and parameters, and each becomes an ordinary job you can follow through the Jobs API.

    Route: https://www.ivybiosciences.com/api/v1/jobs/batch

    Authenticate with Authorization: Bearer ivy_... or a Clerk JWT.


    Submit Batch

    POST /api/v1/jobs/batch (reference)

    Body fieldMeaning
    jobsRequired. Array of { jobType, parameters, title? }, 1 to 100 entries
    projectIdOptional project for every job
    campaignIdOptional campaign for every job
    batchTagOptional label to group the batch
    curl -X POST https://www.ivybiosciences.com/api/v1/jobs/batch \
      -H "Authorization: Bearer ivy_your_key" \
      -H "Content-Type: application/json" \
      -d '{
        "batchTag": "aspirin-analogs",
        "jobs": [
          {"jobType": "admet_ai", "parameters": {"smiles": "CC(=O)Oc1ccccc1C(=O)O"}},
          {"jobType": "admet_ai", "parameters": {"smiles": "CC(=O)Nc1ccc(O)cc1"}}
        ]
      }'

    The response is { submitted, failed, results, batchId }; each entry in results has the request index, the new jobId, its jobType and status (queued or failed).

    jobType must be one of the batch-enabled tools: admet_ai, deeppurpose, rdkit_descriptors, esmfold, diffdock, aizynthfinder, pywpem, opxrd, graphsol, reinvent4 or xtalnet. Any other type fails the whole request with 400 VALIDATION_ERROR.


    Get Batch Status

    GET /api/v1/jobs/batch?ids=<id1>,<id2> (reference) returns { jobs } with the current record of each job you own, up to 200 IDs per call. ids also accepts a JSON array.


    Limits

    LimitValue
    Jobs per request100
    IDs per status read200

    Was this page helpful?

    On this page

    On this page

    Loading...