Skip to content

Projects

Projects allow you to organize your designs into logical groups.

INFO

Only designs listed in the Projects page in the Abyssale dashboard are accessible via API.

Projects are organizational containers for your Abyssale designs. Use the Projects API to list existing projects or create new ones programmatically — useful when automating workspace setup or building multi-tenant integrations.

Each project returned includes its id (required for design creation) and its name.

List Projects

GET/projectsAPI Reference

Response

Returns an array of project objects.

FieldTypeDescription
idstring (uuid)Unique identifier of the project.
namestringName of the project.
created_at_tsintegerUnix timestamp of when the project was created.

Response Example

json
[
  {
    "id": "9d00e9fe-9bd5-4471-acad-baa702a867e9",
    "name": "Animation Tests",
    "created_at_ts": 1654763057
  },
  {
    "id": "bdf9ab44-f5fd-47ad-881d-a45906901233",
    "name": "HTML5 Tests",
    "created_at_ts": 1663767647
  }
]

Create Project

POST/projectsAPI Reference

Request Body

FieldTypeRequiredDescription
namestringYesName of the project. Between 2 and 100 characters.

Response

Returns the created project object.

FieldTypeDescription
idstring (uuid)Unique identifier of the new project.
namestringName of the project.
created_at_tsintegerUnix timestamp of when the project was created.

Response Example

json
{
  "id": "cb2c4add-4867-11f0-96f2-0a00d9eb8f78",
  "name": "Summer Campaign 2024",
  "created_at_ts": 1749827107
}