> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# abyssale

> Abyssale API

**Server path:** `/abyssale` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                  | Description                    |
| --------------------------------------------------------------------- | ------------------------------ |
| [`abyssale_check_auth`](#abyssale_check_auth)                         | Test authentication            |
| [`abyssale_create_project`](#abyssale_create_project)                 | Create a project               |
| [`abyssale_export_banners`](#abyssale_export_banners)                 | Export banners as ZIP          |
| [`abyssale_generate_async`](#abyssale_generate_async)                 | Generate assets asynchronously |
| [`abyssale_generate_image`](#abyssale_generate_image)                 | Generate image synchronously   |
| [`abyssale_get_design`](#abyssale_get_design)                         | Get design details             |
| [`abyssale_get_design_format`](#abyssale_get_design_format)           | Get design format details      |
| [`abyssale_get_duplication_status`](#abyssale_get_duplication_status) | Get duplication request status |
| [`abyssale_get_generation_status`](#abyssale_get_generation_status)   | Get generation request status  |
| [`abyssale_list_designs`](#abyssale_list_designs)                     | List all designs               |
| [`abyssale_list_fonts`](#abyssale_list_fonts)                         | List all fonts                 |
| [`abyssale_list_projects`](#abyssale_list_projects)                   | List all projects              |
| [`abyssale_use_workspace_template`](#abyssale_use_workspace_template) | Duplicate workspace template   |

***

## abyssale\_check\_auth

Test authentication

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## abyssale\_create\_project

Create a project

**Parameters:**

| Parameter | Type   | Required | Default | Description                     |
| --------- | ------ | -------- | ------- | ------------------------------- |
| `name`    | string | Yes      | —       | Project name (2-100 characters) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Project name (2-100 characters)"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## abyssale\_export\_banners

Export banners as ZIP

**Parameters:**

| Parameter      | Type      | Required | Default | Description                                               |
| -------------- | --------- | -------- | ------- | --------------------------------------------------------- |
| `callback_url` | string    | Yes      | —       | Webhook URL to receive the export completion notification |
| `ids`          | string\[] | Yes      | —       | Array of banner UUIDs to export                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "callback_url": {
        "type": "string",
        "description": "Webhook URL to receive the export completion notification"
      },
      "ids": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of banner UUIDs to export"
      }
    },
    "required": [
      "PCID",
      "callback_url",
      "ids"
    ]
  }
  ```
</Expandable>

***

## abyssale\_generate\_async

Generate assets asynchronously

**Parameters:**

| Parameter               | Type      | Required | Default | Description                                                                                             |
| ----------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
| `designId`              | string    | Yes      | —       | Design UUID                                                                                             |
| `callback_url`          | string    | No       | —       | Webhook URL for completion notification                                                                 |
| `elements`              | object    | No       | —       | Element overrides keyed by element name. Each value is an object with element-type-specific properties. |
| `image_file_type`       | string    | No       | —       | Output file type                                                                                        |
| `template_format_names` | string\[] | No       | —       | Format names to generate. If omitted, generates all formats.                                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "designId": {
        "type": "string",
        "description": "Design UUID"
      },
      "callback_url": {
        "type": "string",
        "description": "Webhook URL for completion notification"
      },
      "elements": {
        "type": "object",
        "description": "Element overrides keyed by element name. Each value is an object with element-type-specific properties."
      },
      "image_file_type": {
        "type": "string",
        "description": "Output file type",
        "enum": [
          "png",
          "jpeg",
          "webp",
          "avif",
          "pdf",
          "gif",
          "html5",
          "mp4"
        ]
      },
      "template_format_names": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Format names to generate. If omitted, generates all formats."
      }
    },
    "required": [
      "PCID",
      "designId"
    ]
  }
  ```
</Expandable>

***

## abyssale\_generate\_image

Generate image synchronously

**Parameters:**

| Parameter              | Type   | Required | Default | Description                                                                                                                                            |
| ---------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `designId`             | string | Yes      | —       | Design UUID                                                                                                                                            |
| `elements`             | object | No       | —       | Element overrides keyed by element name. Each value is an object with element-type-specific properties (e.g. payload for text, image\_url for images). |
| `image_file_type`      | string | No       | —       | Output file type                                                                                                                                       |
| `template_format_name` | string | Yes      | —       | Name of the format to generate                                                                                                                         |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "designId": {
        "type": "string",
        "description": "Design UUID"
      },
      "elements": {
        "type": "object",
        "description": "Element overrides keyed by element name. Each value is an object with element-type-specific properties (e.g. payload for text, image_url for images)."
      },
      "image_file_type": {
        "type": "string",
        "description": "Output file type",
        "enum": [
          "png",
          "jpeg",
          "webp",
          "avif",
          "pdf"
        ]
      },
      "template_format_name": {
        "type": "string",
        "description": "Name of the format to generate"
      }
    },
    "required": [
      "PCID",
      "designId",
      "template_format_name"
    ]
  }
  ```
</Expandable>

***

## abyssale\_get\_design

Get design details

**Parameters:**

| Parameter  | Type   | Required | Default | Description                                               |
| ---------- | ------ | -------- | ------- | --------------------------------------------------------- |
| `designId` | string | Yes      | —       | Design UUID                                               |
| `i`        | string | No       | —       | Set to 'advanced' to retrieve advanced element properties |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "designId": {
        "type": "string",
        "description": "Design UUID"
      },
      "i": {
        "type": "string",
        "description": "Set to 'advanced' to retrieve advanced element properties",
        "enum": [
          "advanced"
        ]
      }
    },
    "required": [
      "PCID",
      "designId"
    ]
  }
  ```
</Expandable>

***

## abyssale\_get\_design\_format

Get design format details

**Parameters:**

| Parameter         | Type   | Required | Default | Description        |
| ----------------- | ------ | -------- | ------- | ------------------ |
| `designId`        | string | Yes      | —       | Design UUID        |
| `formatSpecifier` | string | Yes      | —       | Format name or UID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "designId": {
        "type": "string",
        "description": "Design UUID"
      },
      "formatSpecifier": {
        "type": "string",
        "description": "Format name or UID"
      }
    },
    "required": [
      "PCID",
      "designId",
      "formatSpecifier"
    ]
  }
  ```
</Expandable>

***

## abyssale\_get\_duplication\_status

Get duplication request status

**Parameters:**

| Parameter            | Type   | Required | Default | Description              |
| -------------------- | ------ | -------- | ------- | ------------------------ |
| `duplicateRequestId` | string | Yes      | —       | Duplication request UUID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "duplicateRequestId": {
        "type": "string",
        "description": "Duplication request UUID"
      }
    },
    "required": [
      "PCID",
      "duplicateRequestId"
    ]
  }
  ```
</Expandable>

***

## abyssale\_get\_generation\_status

Get generation request status

**Parameters:**

| Parameter               | Type   | Required | Default | Description             |
| ----------------------- | ------ | -------- | ------- | ----------------------- |
| `generation_request_id` | string | Yes      | —       | Generation request UUID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "generation_request_id": {
        "type": "string",
        "description": "Generation request UUID"
      }
    },
    "required": [
      "PCID",
      "generation_request_id"
    ]
  }
  ```
</Expandable>

***

## abyssale\_list\_designs

List all designs

**Parameters:**

| Parameter     | Type   | Required | Default | Description             |
| ------------- | ------ | -------- | ------- | ----------------------- |
| `category_id` | string | No       | —       | Filter by category UUID |
| `type`        | string | No       | —       | Filter by design type   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "category_id": {
        "type": "string",
        "description": "Filter by category UUID"
      },
      "type": {
        "type": "string",
        "description": "Filter by design type",
        "enum": [
          "static",
          "animated",
          "printer",
          "printer_multipage"
        ]
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## abyssale\_list\_fonts

List all fonts

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## abyssale\_list\_projects

List all projects

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## abyssale\_use\_workspace\_template

Duplicate workspace template

**Parameters:**

| Parameter           | Type   | Required | Default | Description                                              |
| ------------------- | ------ | -------- | ------- | -------------------------------------------------------- |
| `companyTemplateId` | string | Yes      | —       | Workspace template UUID                                  |
| `name`              | string | No       | —       | Custom name for the duplicated design (2-100 characters) |
| `project_id`        | string | Yes      | —       | Destination project UUID                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "companyTemplateId": {
        "type": "string",
        "description": "Workspace template UUID"
      },
      "name": {
        "type": "string",
        "description": "Custom name for the duplicated design (2-100 characters)"
      },
      "project_id": {
        "type": "string",
        "description": "Destination project UUID"
      }
    },
    "required": [
      "PCID",
      "companyTemplateId",
      "project_id"
    ]
  }
  ```
</Expandable>