Projects

List all projects of your workspace

All of your existing projects can be retrieved from the GET /projects route.

Get Projects

get

Retrieve all of your projects (containing id, name & creation date)

Authorizations

api_key

x-api-keystringRequired

All of your Abyssale requests must contain a x-api-key header with your API Key.

Responses

200

Ok

application/json

idstring · uuidRequired

Unique identifier of the project

Example: d59adee9-4867-11f0-96f2-0a00d9eb8f78

namestringRequired

Name of the project

Example: HTML5 Tests

created_at_tsintegerRequired

Unix timestamp when the project was created

Example: 1749827125

401

Unauthorized

get

/projects

HTTPcURLJavaScriptPython

GET /projects HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "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 a new project

You can create a new project with the POST /projects route.

Create Project

post

Create a new project to organize your templates and images

Authorizations

api_key

x-api-keystringRequired

All of your Abyssale requests must contain a x-api-key header with your API Key.

Body

application/json

namestring · min: 2 · max: 100Required

Name of the project

Example: Summer Campaign 2024

Responses

200

Project created successfully

application/json

idstring · uuidRequired

Unique identifier of the project

Example: d59adee9-4867-11f0-96f2-0a00d9eb8f78

namestringRequired

Name of the project

Example: HTML5 Tests

created_at_tsintegerRequired

Unix timestamp when the project was created

Example: 1749827125

post

/projects

HTTPcURLJavaScriptPython

POST /projects HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "Summer Campaign 2024"
}

200

Project created successfully

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