Skip to main content
Send a teamId and optional name. Returns the active project. Use a team where your API key has write access.

Signature

Method signature on client.projects:

Parameters

string
required
The team that will own the project.
string
Name of the project; defaults to New Project.

Returns

Promise<Project> A project: a team-scoped container for pipelines and datasets.
ProjectId
required
Project ID with prefix pp..
string
required
Name of the project.
string
required
Identifier of the team that owns the project.
"draft" | "active"
required
Project state: draft before activation or active after activation.
string
required
Time the project was created, as an ISO 8601 timestamp.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: POST /projects.