Abyssale Developer Hub
  • Getting Started
  • Rest API
    • Overview - Rest API
    • Authentication
    • Designs
      • Design Details
    • Generation
      • Design information
      • Synchronous generation
        • Generate single image
      • Asynchronous generation
        • Generate Multi-Format images
        • Generate Multi-Format PDFs for Printing
        • Generate Multi-Page PDF for Printing
        • Generate Multi-Format Videos
        • Generate Multi-Format Animated GIFs
        • Generate HTML5 Banner Ads
          • ad network
      • Element properties
        • Root
        • Text
        • Button
        • Image
        • Logo
        • Shape
        • Rating
        • Illustration
        • QR Code
        • Video
        • Audio
      • Errors
    • Image Export
    • Fonts
    • Projects
    • Workspace Templates
    • Annexes
    • API Reference
  • Dynamic Images
    • Overview - Dynamic Images
    • Dynamic Image generation with URL
  • Webhooks
    • Overview - Webhooks
    • Events
      • Design
      • Banner
      • Global events
Powered by GitBook
On this page
  1. Rest API

Projects

PreviousFontsNextWorkspace Templates

Last updated 1 day ago

List all projects of your workspace

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

Create a new project

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

Get Projects

get

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

Authorizations
Responses
200
Ok
application/json
401
Unauthorized
get
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
  }
]
  • List all projects of your workspace
  • GETGet Projects
  • Create a new project
  • POSTCreate Project

Create Project

post

Create a new project to organize your templates and images

Authorizations
Body
namestring · min: 2 · max: 100Required

Name of the project

Example: Summer Campaign 2024
Responses
200
Project created successfully
application/json
post
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
}