Workspace Templates

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.

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

api_key

x-api-keystringRequired

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

Path parameters

companyTemplateIdstring · uuidRequired

Unique identifier (UUID) of the workspace template to duplicate

Example: 0c967bd0-4137-4690-ad70-249aa021c68b

Body

application/json

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

/workspace-templates/{companyTemplateId}/use

HTTPcURLJavaScriptPython

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"
}

Basic template duplicationDuplication with custom name

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

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

api_key

x-api-keystringRequired

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

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

/design-duplication-requests/{duplicateRequestId}

HTTPcURLJavaScriptPython

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"
    }
  ]
}