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

Workspace Templates

PreviousProjectsNextAnnexes

Last updated 1 day ago

You can duplicate a workspace template within a project with the POST /workspace-templates/{companyTemplateId}/use endpoint.

This call is asynchronous, meaning the response will only include a "duplication_request_id". You can use this ID to track the duplication process with the GET /design-duplication-requests/{duplicateRequestId polling endpoint.

Duplication Request Polling - Propress check endpoint

You can poll the following endpoint to retrieve the progress status of a duplication request.

This endpoint remains available for up to 7 days after the duplication request is created.

Get Duplication Request Status

get

Poll the status of a template duplication request. Use this endpoint to track the progress of an asynchronous duplication operation.

Authorizations
Path parameters
duplicateRequestIdstring · uuidRequired

Unique identifier (UUID) of the duplication request

Example: 40c32a4e-4869-11f0-96f2-0a00d9eb8f78
Responses
200
Duplication request status
application/json
404
Duplication request not found
get
GET /design-duplication-requests/{duplicateRequestId} HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Accept: */*
{
  "request_id": "40c32a4e-4869-11f0-96f2-0a00d9eb8f78",
  "status": "COMPLETED",
  "created_at_ts": 1749827734,
  "completed_at_ts": 1749827736,
  "errored_at_ts": null,
  "target_project": {
    "id": "d59adee9-4867-11f0-96f2-0a00d9eb8f78",
    "name": "HTML5 Tests",
    "created_at_ts": 1749827125
  },
  "designs": [
    {
      "original_design_id": "0c967bd0-4137-4690-ad70-249aa021c68b",
      "target_design_id": "afb1a61a-6c50-4bc3-a49b-3381822d4e81",
      "target_design_name": "New Design name"
    }
  ]
}
  • POSTDuplicate Workspace Template
  • Duplication Request Polling - Propress check endpoint
  • GETGet Duplication Request Status

Duplicate Workspace Template

post

Duplicate a workspace template into a project. This operation is asynchronous. Use the returned duplication_request_id to track the duplication progress with the polling endpoint.

Authorizations
Path parameters
companyTemplateIdstring · uuidRequired

Unique identifier (UUID) of the workspace template to duplicate

Example: 0c967bd0-4137-4690-ad70-249aa021c68b
Body
project_idstring · uuidRequired

Target project ID where the template will be duplicated

Example: d59adee9-4867-11f0-96f2-0a00d9eb8f78
namestring · min: 2 · max: 100Optional

Optional custom name for the duplicated template

Example: My Custom Template
Responses
200
Duplication request accepted and processing
application/json
404
Workspace template Or Project not found
post
POST /workspace-templates/{companyTemplateId}/use HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "project_id": "d59adee9-4867-11f0-96f2-0a00d9eb8f78"
}
{
  "duplication_request_id": "40c32a4e-4869-11f0-96f2-0a00d9eb8f78"
}