POST
/api/v1/projects

Creates a new project for the authenticated user. IDs are server-generated; omitted fields use schema defaults.


Authentication

Request

  • Method: POST
  • URL: /api/v1/projects

Parameters

name string
Project name. Default: "Untitled Project".
thumb string
Thumbnail URL. Default: "".
artboards Artboard []
Initial artboards. Default: [].
popups Popup []
Initial popups. Default: [].
data_sources DataSource []
Initial data sources. Default: [].
variables Variable []
Initial variables. Default: [].
actions Action []
Initial actions. Default: [].
settings ProjectSettings
Project settings. Defaults applied if omitted.
created number
Unix ms timestamp. Defaults to now.

Response

  • 201 Created: A Project object.
  • 400 Bad Request: Validation failed. Returns a formatted error message.
  • 401 Unauthorized: API key is missing or invalid.
  • 500 Internal Server Error: Failed to create Project.

Example Request

Example Response