Skip to main content
POST
Requires version 2.0.0 or later of the Archetype platform.

Overview

This endpoint creates a project. The project starts empty and is visible to its creator and to the organization’s admins. A project created with a service-account API key is visible to every service-account key of the organization instead of a single user. Put blueprints in the project by registering them with project_id in Create Blueprint, or by copying them into the project with Copy Blueprint. See About the Projects API for what a project holds.

Request

string
required
Display name, at most 128 characters once leading and trailing whitespace is dropped. Must not be blank, and must differ, ignoring case, from the names of the other projects you created.
string
Description, at most 512 characters. Defaults to an empty string.

Response

Returns 201 Created with the project.
string
required
The project’s prj_ ID.
string
required
Display name, as specified.
string
required
Description; empty when none was given.
string
required
Who created the project: a user’s usr_ id, or the key_ id of the service-account API key it was created with. Never changes.
string
required
When the project was created (date-time).
string
required
When the project’s name or description last changed (date-time); its creation time until then.

Important Notes

  • 400 means name is blank or too long, or description is too long.
  • 403 means the caller has the read-only viewer role.
  • 409 means you already created a project of that name, ignoring case. Names are unique per creator, so two users can each have a project with the same name. Service-account API keys share one set of names.