File a job under a project with project_id, list only that project's jobs, and file a whole batch under it. Projects are created in the web app or the CLI.

The Projects API lets you group computational jobs into logical units for collaboration, billing, and access control. Reach for it when you want to organize the work you run through the Jobs API rather than tracking loose jobs. Projects are the organizational container the rest of the job-running surface hangs off of.

Difficulty

beginner

Time

10 min

Prerequisites

authentication

Projects API

A project groups the jobs, files and members of one line of work, and scopes who can see them.

The public REST API does not create, rename or delete projects. Manage them in the web app, or with the CLI: ivybloom projects list, ivybloom projects info and ivybloom projects init. Over the REST API you use a project through its id:

File a Job Under a Project

Submit through the Jobs API with project_id set. You need access to the project.

List a Project's Jobs

GET /api/v1/jobs?projectId=<id> (reference) returns only the jobs in that project.

Batch Into a Project

POST /api/v1/jobs/batch (reference) takes projectId and files every job in the batch under it.

Projects REST API