> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Abyssale

The Abyssale connector lets your AI agent act in each user's Abyssale account. Each user connects their own Abyssale API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 32 tools.

**Authentication:** API Key
**Categories:** Design, Marketing
**Tools:** 32: 17 read, 14 write, 1 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=ABYSSALE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Abyssale connection

   In **AgentKit > Connections**, create an Abyssale connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'abyssale'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Abyssale:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'abyssale_ai_models_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "abyssale"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Abyssale:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="abyssale_ai_models_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Abyssale credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'abyssale_ai_models_list',
  toolInput: {},
  connector: 'abyssale',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="abyssale_ai_models_list",
    tool_input={},
    connection_name="abyssale",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `abyssale_ai_models_list`

List AI Models · Read-only

List the AI models the workspace can use for each AI action, with the default model.
Returns per-operation models with their allowed aspect ratios, qualities, upscale factors and reference image limits.
Use this before the AI image tools to pick a model.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `operation` (`string`, optional): The AI action to list models for. Omit it to list every action. Any other value answers 400 unknown_enum_value. Example: images_remove_background. One of: `images_remove_background`, `images_text_to_image`, `images_upscale`.

Example input: `{}`

### `abyssale_api_key_verify`

Verify API Key · Read-only

Check that the API key works and find out which workspace it belongs to.
Returns the workspace details for a valid key; an invalid, revoked or unentitled key answers 401.
Use this first to test the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `abyssale_asset_job_get`

Get Asset Job · Read-only

Get the status of a background removal, text-to-image or upscale job.
Returns status (PENDING, PROCESSING, COMPLETED or FAILED) and, when completed, the outputs and credits used.
Branch on status: a failed job still answers 200.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `job_id` (`string`, required): job_id returned by abyssale_image_background_remove, abyssale_image_text_to_image or abyssale_image_upscale. Example: 8c9d0e1f-2a3b-4c5d-8e7f-9a0b1c2d3e4f.

Example input: `{"job_id":"<job_id>"}`

### `abyssale_credits_get`

Get Remaining Credits · Read-only

Get the workspace's remaining generation and AI credits for the current billing period.
Returns credit balances.
Check this before large generation runs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `abyssale_design_as_import_get`

Export Design as Import · Read-only

Export an existing design as the exact JSON body abyssale_design_import_create accepts (Alpha).
Returns the design's name, type, formats and layers in import form.
Use this to clone, version or back up a design.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.

Example input: `{"design_id":"<design_id>"}`

### `abyssale_design_format_get`

Get Design Format · Read-only

Get one format of a design: dimensions, unit, preview URL, dynamic image URL, element layout and variables.
Returns the format's details.
Use abyssale_design_get to list a design's formats.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `format_specifier` (`string`, required): Format name or UID of the design's format, from abyssale_design_get. Prefer the UID: it survives a rename. Example: facebook-post.

Example input: `{"design_id":"<design_id>","format_specifier":"<format_specifier>"}`

### `abyssale_design_get`

Get Design · Read-only

Get a design's full specification: formats with dimensions and previews, every configurable element with its properties, and template variables.
Returns the design's name, type, formats and elements.
Use this to learn which element names and properties to send to the generation tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `detail` (`string`, optional): Pass advanced to get the full layer and property set, including group layers that the default response leaves out. Example: advanced. One of: `advanced`.

Example input: `{"design_id":"<design_id>"}`

### `abyssale_design_import_get`

Get Design Import · Read-only

Get the status of a JSON design import (Alpha).
Returns status (WAITING_FOR_VALIDATION, QUEUED, PROCESSING, DONE or FAILED), warnings, errors, the new design id when done, and next_check_after_ms.
Poll this after abyssale_design_import_validate.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `import_id` (`string`, required): Import ID (UUID) returned by abyssale_design_import_create. Example: 4c5d6e7f-8a9b-4c0d-9e1f-2a3b4c5d6e7f.

Example input: `{"import_id":"<import_id>"}`

### `abyssale_design_imports_list`

List Design Imports · Read-only

List the workspace's JSON design imports, newest first, optionally by status or creation time (Alpha).
Returns each import's id, status, name and timestamps.
Use this to recover an import ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `created_after` (`integer`, optional): Unix timestamp (seconds). Return imports created at or after this moment. Example: 1730419200.
- `created_before` (`integer`, optional): Unix timestamp (seconds). Return imports created at or before this moment. Example: 1731024000.
- `limit` (`integer`, optional): Maximum number of imports to return. Defaults to 50. Example: 50.
- `status` (`string`, optional): Return only imports whose effective status matches. Example: WAITING_FOR_VALIDATION. One of: `WAITING_FOR_VALIDATION`, `QUEUED`, `PROCESSING`, `DONE`, `FAILED`.

Example input: `{}`

### `abyssale_designs_list`

List Designs · Read-only

List and search the designs in the workspace by text, project, type, format shape or size, and date.
Returns each design's id, name, type, project, formats and preview URLs, plus X-Total-Count when paging.
Use this to find a design_id. Use abyssale_design_get for its layers before generating.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `created_since` (`string`, optional): Only designs created at or after this moment, in the same format as updated_since. Example: 2026-01-01T00:00:00Z.
- `format` (`string`, optional): Format names (the IDs generation takes as template_format_name) to include, at most 10. Several values go comma-separated. Example: facebook-post.
- `name` (`string`, optional): One exact phrase that must appear in the design name (case- and accent-insensitive). Example: Summer sale.
- `order` (`string`, optional): Defaults to asc (A to Z) for name and desc (newest first) for updated and created. An unknown value answers 400 unknown_enum_value. Example: asc. One of: `asc`, `desc`.
- `orientation` (`string`, optional): Only designs with at least one format of this shape. An unknown value answers 400 unknown_enum_value. Example: portrait. One of: `portrait`, `landscape`, `square`.
- `page` (`integer`, optional): 1-based page number. Sending page or per_page turns paging on; without either every match is returned. Defaults to 1. Example: 1.
- `per_page` (`integer`, optional): Items per page when paging, up to 100. Defaults to 25. Example: 25.
- `project` (`string`, optional): One exact phrase that must appear in the project name. Several projects can match; use project_id for exactly one. Example: Marketing.
- `project_id` (`string`, optional): Unique identifier (UUID) of a project. Filter designs by project. Example: 9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73.
- `query` (`string`, optional): Words to find, in any order. Every word must appear in the design name **or** the project name, ignoring case and accents. Words are split on spaces and on - _ | / ·, so black friday matches Black-Friday – Story. At most 8 words; more answers 400 out_of_range. Example: black friday.
- `size` (`string`, optional): Format sizes to include as <width>x<height> in the design's unit (pixels, or mm or inches for print), at most 10. Several values go comma-separated. Example: 1080x1080.
- `sort` (`string`, optional): updated is the last time the design was saved in the editor (renaming or moving a design does not count); created is its creation. An unknown value answers 400 unknown_enum_value. Defaults to name. Example: name. One of: `name`, `updated`, `created`.
- `type` (`string`, optional): Design types to include: static, animated, printer or printer_multipage. Several values go comma-separated. Example: static.
- `updated_since` (`string`, optional): Only designs last saved in the editor at or after this moment: an ISO 8601 date (midnight UTC) or date-time (UTC when it has no offset). Anything else answers 400 wrong_type. Example: 2026-10-01.

Example input: `{}`

### `abyssale_duplication_request_get`

Get Duplication Request · Read-only

Get the status of a workspace template duplication.
Returns the status and, when done, the new design's id.
Use this to poll abyssale_workspace_template_use.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `duplicate_request_id` (`string`, required): duplication_request_id returned by abyssale_workspace_template_use. Example: 2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e.

Example input: `{"duplicate_request_id":"<duplicate_request_id>"}`

### `abyssale_file_get`

Get Generated File · Read-only

Get a previously generated file (image, video, GIF, HTML5 banner or PDF).
Returns its metadata, storage URL and CDN URL for embedding.
Use abyssale_banners_export to zip several files.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `banner_id` (`string`, required): ID (UUID) of the generated file, returned by a generation call or its webhook. Example: 3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9.

Example input: `{"banner_id":"<banner_id>"}`

### `abyssale_fonts_list`

List Fonts · Read-only

List and search the workspace's fonts, Google and custom, by name, category, weight and style.
Returns each font's id, name, type, category and available weights.
Use a font id to override fonts on text or button elements in generation.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`string`, optional): Only Google fonts of this category. Custom fonts have no category, so they never match. An unknown value answers 400 unknown_enum_value. Example: serif. One of: `serif`, `sans-serif`, `display`, `handwriting`, `monospace`.
- `name` (`string`, optional): Text in the font name, matched ignoring case, accents, spaces, hyphens and underscores (OpenSans finds Open Sans). Exact names come first, then names starting with the text, then the rest — alphabetically within each. Example: Open Sans.
- `page` (`integer`, optional): 1-based page number. Sending page or per_page turns paging on; without either every match is returned. Defaults to 1. Example: 1.
- `per_page` (`integer`, optional): Items per page when paging, up to 100. Defaults to 25. Example: 25.
- `style` (`string`, optional): Only fonts with a variant in this style. With weight, that weight in that style (weight=700&style=italic keeps fonts that have 700-italic). Apply an italic variant at generation with text markup: <w=italic>…</w>, or <w=700-italic>…</w>. An unknown value answers 400 unknown_enum_value. Example: normal. One of: `normal`, `italic`.
- `type` (`string`, optional): Filter fonts by type. Omit to return both Google and custom fonts. An unknown value is **ignored** and the full unfiltered list is returned — this never answers 400 (long-standing behavior existing integrations rely on). Example: google. One of: `google`, `custom`.
- `weight` (`integer`, optional): Only fonts available in this weight (700 is bold): upright, or italic with style=italic. Any other value answers 400 out_of_range. Example: 100. One of: `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`.

Example input: `{}`

### `abyssale_generation_request_get`

Get Generation Request · Read-only

Get the status and results of an asynchronous generation request, for 7 days after it ran.
Returns the status and, when done, each generated file's id and URLs.
Use this to poll abyssale_media_generate or abyssale_multipage_pdf_generate.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `generation_request_id` (`string`, required): generation_request_id returned by an asynchronous generation call. Example: 1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d.

Example input: `{"generation_request_id":"<generation_request_id>"}`

### `abyssale_projects_list`

List Projects · Read-only

List and search the workspace's projects, ordered by name.
Returns each project's id and name.
Use a project id to filter abyssale_designs_list or as a target for moves and imports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): One exact phrase that must appear in the project name (case- and accent-insensitive). Example: Marketing.
- `page` (`integer`, optional): 1-based page number. Sending page or per_page turns paging on; without either every match is returned. Defaults to 1. Example: 1.
- `per_page` (`integer`, optional): Items per page when paging, up to 100. Defaults to 25. Example: 25.

Example input: `{}`

### `abyssale_workspace_template_categories_list`

List Workspace Template Categories · Read-only

List the categories that group workspace templates.
Returns each category's id and name.
Use an id as category_id in abyssale_workspace_templates_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `abyssale_workspace_templates_list`

List Workspace Templates · Read-only

List the workspace's shared master templates, optionally by category or type.
Returns each template's id, name, type, category and formats.
Duplicate one into a project with abyssale_workspace_template_use before generating from it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category_id` (`string`, optional): Unique identifier (UUID) of a workspace category. List the available ids with GET /workspace-template-categories. Categories are optional, so this filter only ever returns categorised templates — omit it to include those at the workspace root. Example: 5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b.
- `type` (`string`, optional): Filter workspace templates by one of these types: static, animated, printer, printer_multipage. An unknown value is **ignored** and the full unfiltered list is returned — this never answers 400 (long-standing behavior existing integrations rely on). Example: static. One of: `static`, `printer`, `animated`, `printer_multipage`.

Example input: `{}`

### `abyssale_banners_export`

Export Files as ZIP · Write

Start packaging previously generated files into one ZIP archive.
Returns an export ID; the archive URL is sent to callback_url when ready.
Set callback_url to receive the archive link.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `ids` (`array`, required): An array of string that corresponds to the banners IDs you would like to export. Example: ["3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9"]
- `callback_url` (`string`, optional): The url that will be called once the generation of your export is done. Example: https://example.com/webhooks/abyssale.

Example input: `{"ids":["3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9"]}`

### `abyssale_design_import_create`

Create Design from JSON · Write

Submit a design (formats and layers, or pages for multi-page print) as JSON to create a new design (Alpha).
Returns the import id, links, and uploads[] with a presigned upload for each asset given as a bare filename.
Use public image URLs so no uploads are needed, then call abyssale_design_import_validate. Use validate_only true to check a payload.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Design name. Any Unicode character in the Basic Multilingual Plane is accepted; emoji and every other character at U+10000 or above are invalid_payload (the name is stored in a column that cannot hold them). Example: Summer sale.
- `type` (`string`, required): Design type. static = single image; printer = single-page print PDF; animated = animated/video design; printer_multipage = multi-page print PDF. Printer payloads are authored in physical units — the design declares unit (mm | in) **once at the top level**, geometry is floats in that unit, font sizes are pt, and colors are stored as cmyk (a solid hex is converted with a color_converted warning; a gradient is accepted only on a shape or button background_color, with opaque stops). Animated payloads are px-authored like static and require a top-level animation object; they may use video/audio layers and per-layer animation timing/tweens. **Muting is spelled differently on each of the three surfaces, and the type changes too.** Importing takes muted (a boolean, on the video/audio layer properties); reading a design returns it as the attributes video_muted / audio_muted (booleans); overriding it at generation time takes audio_muted as a **number** 0–1, where true/false answer 400. Convert deliberately when moving a value between them. Multipage payloads (printer_multipage) drop formats/layers, declare the print setup once at the top level (unit/width/height required, bleed_size/safe_size/dpi optional), and carry a top-level ordered pages array (1–30 pages); each page is a self-contained print page (own background_color + layers, inheriting the document-wide print setup) that inherits every per-layer printer rule. No shared layers exist — a repeated element is included per page. Example: static. One of: `static`, `printer`, `animated`, `printer_multipage`.
- `animation` (`object`, optional): Animated designs only (required there): the timeline, such as its duration in seconds. Example: {"duration": 6}
- `bleed_size` (`number`, optional): **printer_multipage designs only.** Optional bleed size as a float in unit; presence enables bleed on every page. Example: 3.
- `dpi` (`integer`, optional): **printer_multipage designs only.** Optional global render DPI for the whole document. Because the document has a single page size there is exactly one area-based ceiling min(300, floor(72*sqrt(225000000/(w_pt*h_pt)))); a higher value is rejected with out_of_range at dpi (carrying expected: {max: <ceiling>} and received). Omitted ⇒ the backend computes that same ceiling as the default, identically for every page. On printer designs dpi is a per-format field instead. Example: 300.
- `formats` (`array`, optional): Formats (1-20) for static, printer and animated designs, each with a name, width and height and optional background_color. Omit for printer_multipage. Example: [{"name": "facebook-post", "width": 1200, "height": 1200, "background_color": "#F3F3F3"}]
- `height` (`number`, optional): **printer_multipage designs only — required.** Page height as a float in unit, shared by every page. Same bound as width, reported at height. Example: 297.
- `layers` (`array`, optional): Layers (1-80) for static, printer and animated designs. Each has a name, a type (text, image, logo, shape, button, rating, qrcode, group, illustration, plus video and audio on animated), a layout box and type-specific properties. Give images as public URLs to avoid uploads. Omit for printer_multipage. Example: [{"name": "title", "type": "text", "layout": {"x": 80, "y": 760, "width": 1040, "height": 220}, "properties": {"payload": "Summer sale", "color": "#111111", ...
- `pages` (`array`, optional): printer_multipage designs only: ordered pages (1-30), each with its own layers and optional background color. Example: [{"layers": [{"name": "title", "type": "text", "layout": {"x": 20, "y": 20, "width": 170, "height": 40}, "properties": {"payload": "Spring catalog"}}]}]
- `safe_size` (`number`, optional): **printer_multipage designs only.** Optional safe-zone size as a float in unit; presence enables the safe zone on every page. Example: 5.
- `strict` (`boolean`, optional): When true, a text layer that cannot fit its box even at min_font_size fails the import instead of importing with a text_fit_failed warning. **It never changes this response.** Text fitting is measured while the design is built, long after this call has answered, so strict cannot produce a 400. The import is accepted exactly as it would be otherwise, and the difference shows up when you poll: status: "FAILED" with error.code: "text_fit_failed" — delivered as HTTP 200, like every other terminal import state. Without strict the same condition appears as a warnings[] entry and the import succeeds. Defaults to false. Example: true.
- `target` (`object`, optional): Where the import lands: {"kind": "design", "project_uuid": "<project id>"} for a design in a project (project_uuid is required), or kind workspace_template for a reusable template. Example: {"kind": "design", "project_uuid": "9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73"}
- `unit` (`string`, optional): **Print designs only (printer and printer_multipage) — required.** Physical authoring unit for **everything** in the document: format/page size, bleed and safe sizes, and every layer's geometry in every format. Declared exactly once, because a print design has one ruler — it does not change between its formats. Missing → missing_required at unit; present on static/animated → unsupported_for_type. A format carrying its own unit is rejected with unknown_field. Example: mm. One of: `mm`, `in`.
- `validate_only` (`boolean`, optional): When true, runs schema and cross-field validation and returns 204 No Content without creating an import row or generating presigned URLs. Defaults to false. Example: true.
- `width` (`number`, optional): **printer_multipage designs only — required.** Page width as a float in unit, shared by every page. At most 10000 mm / 394 in, and at least 1 px at the document's effective render DPI (out_of_range at width). Example: 210.

Example input: `{"name":"<name>","type":"static"}`

### `abyssale_design_import_validate`

Validate Design Import · Write

Validate a JSON design import and queue it for building (Alpha).
Returns the queued import with a link to it in the Abyssale app, or 422 missing_assets listing assets not yet uploaded.
Call after abyssale_design_import_create, then poll abyssale_design_import_get.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `import_id` (`string`, required): Import ID (UUID) returned by abyssale_design_import_create. Example: 4c5d6e7f-8a9b-4c0d-9e1f-2a3b4c5d6e7f.

Example input: `{"import_id":"<import_id>"}`

### `abyssale_design_move`

Move Design · Write

Move a design to another project in the workspace. This resets its approval status.
Returns the updated design.
Use abyssale_projects_list for project IDs.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `project_id` (`string`, required): The id of the destination project, from GET /projects. Example: 9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73.

Example input: `{"design_id":"<design_id>","project_id":"<project_id>"}`

### `abyssale_design_rename`

Rename Design · Write

Rename a design (1 to 100 characters after trimming).
Returns the updated design.
Names need not be unique.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `name` (`string`, required): The new name. Leading and trailing spaces are removed before the length is checked, so a name of spaces only is refused. Example: Summer sale.

Example input: `{"design_id":"<design_id>","name":"<name>"}`

### `abyssale_dynamic_image_url_create`

Create Dynamic Image URL · Write

Create the dynamic image URL for a static design, which renders personalized variants from URL query parameters.
Returns the dynamic image URL; a design has only one, so later calls return the existing URL.
Static designs only.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `enable_production_mode` (`boolean`, optional): Enable Production mode for this dynamic image. Example: true.
- `enable_rate_limit` (`boolean`, optional): Enable API rate limiting for this dynamic image. Example: true.

Example input: `{"design_id":"<design_id>"}`

### `abyssale_image_background_remove`

Remove Image Background · Write

Start an AI job that removes the background of an image at a public URL.
Returns a job_id (202) before processing.
Poll abyssale_asset_job_get for the output. Uses AI credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `image_url` (`string`, required): Public http(s) URL of the image: PNG, JPEG, WebP or SVG, up to 20 MB. It is downloaded when the job runs. Example: https://example.com/product.jpg.
- `callback_url` (`string`, optional): **The http(s) URL called once the job ends**, completed or failed. We will do a POST request of the ASSET_JOB_FINALIZED event on this URL with a JSON payload. Example: https://example.com/webhooks/abyssale.
- `crop` (`boolean`, optional): Crop the transparent edges off the result. Example: true.
- `model` (`string`, optional): The AI model to use, by id — one listed by GET /ai-models?operation=images_remove_background. Omitted, the workspace's default is used. An id that is not a background removal model answers 400. Example: bria-rmbg-2.

Example input: `{"image_url":"<image_url>"}`

### `abyssale_image_generate`

Generate Image · Write

Generate one image synchronously from a static design, overriding element text, images and colors.
Returns the generated file's id, URL, CDN URL, format and file type immediately.
Uses generation credits. Use abyssale_media_generate for several formats, videos, GIFs, HTML5 or print PDFs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `elements` (`object`, optional): Element overrides keyed by layer name, from abyssale_design_get. Each value is an object of properties for that layer, such as payload and color for text, image_url for images, background_color for root. On this endpoint every value must be an object. Example: {"title": {"payload": "Summer sale - 40% off", "color": "#111111"}, "product-image": {"image_url": "https://example.com/product.jpg"}}
- `file_compression_level` (`integer`, optional): Output quality, 1-100 — 100 is the best quality (least compression), 1 the smallest file. Despite the name, higher = better. Example: 80.
- `file_name` (`string`, optional): File name of the generated visual, without extension — returned as file.filename. Replaces the file naming set in the design settings and accepts the same properties: {format_name}, {format_width}, {format_height}, {template_name}, {template_id}, {file_id}, {creation_timestamp} and {layer_name.property} (e.g. {title.payload}). 1–255 characters. Punctuation other than - and _, control characters and characters outside Latin-1 are removed, and a name longer than 255 characters once its properties are replaced is cut at 255; if nothing is left, the design's naming applies. The name is a label, not a key: it never changes the file's url, and several visuals may share it. An export stores each visual under it and adds -1, -2… to repeated names. Example: {template_name}-{format_name}
- `image_file_type` (`string`, optional): Output file type (auto ≡ omitted). When omitted: jpeg, or png when the format's background color is transparent. Example: png. One of: `png`, `jpeg`, `webp`, `avif`, `pdf`, `auto`.
- `original_visual_id` (`string`, optional): Regenerate an existing visual in place, keeping its share URL (visual versioning). Unknown or unrelated visuals answer 404 (visual_not_found, not_related_to_same_template, not_related_to_same_format). Example: 3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9.
- `template_format_name` (`string`, optional): Format ID to generate. Optional — when omitted, the design's first format is generated. Example: facebook-post.

Example input: `{"design_id":"<design_id>"}`

### `abyssale_image_text_to_image`

Generate Image from Prompt · Write

Start an AI job that generates one image from a text prompt, optionally guided by reference images.
Returns a job_id (202) before generation.
Poll abyssale_asset_job_get for the output. Use abyssale_ai_models_list for models, aspect ratios and qualities. Uses AI credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `prompt` (`string`, required): What to generate. At least 3 words. Example: A red running shoe on a white studio background.
- `aspect_ratio` (`string`, optional): The image's shape, as the model names it — one of the model's aspect_ratios.allowed in GET /ai-models?operation=images_text_to_image. Omitted, the model's default. Another value answers 400 unknown_enum_value with the accepted ones in errors[].expected. Example: 1:1.
- `callback_url` (`string`, optional): **The http(s) URL called once the job ends**, completed or failed. We will do a POST request of the ASSET_JOB_FINALIZED event on this URL with a JSON payload. Example: https://example.com/webhooks/abyssale.
- `model` (`string`, optional): The AI model to use, by id — one listed by GET /ai-models?operation=images_text_to_image. Omitted, the workspace's default is used. An id that is not an image generation model answers 400. Example: bria-rmbg-2.
- `quality` (`string`, optional): The image's quality or resolution tier, as the model names it — one of the model's qualities.allowed. Omitted, the model's default. Send none for a model that lists no qualities: it takes none, and any value answers 400 unknown_enum_value. Example: high.
- `reference_image_urls` (`array`, optional): Public http(s) URLs of images that guide the generation: PNG, JPEG or WebP, up to 20 MB each. At least 1, at most the model's max_reference_images from GET /ai-models (16 for the models that take the most). Downloaded when the job runs. The model must accept reference images; some models charge for each one. Example: ["https://example.com/reference.jpg"]

Example input: `{"prompt":"<prompt>"}`

### `abyssale_image_upscale`

Upscale Image · Write

Start an AI job that upscales an image at a public URL by a factor of 1 to 4.
Returns a job_id (202) before processing.
Poll abyssale_asset_job_get for the output. Uses AI credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `image_url` (`string`, required): Public http(s) URL of the image: PNG, JPEG or WebP, up to 20 MB. It is downloaded when the job runs. Example: https://example.com/product.jpg.
- `callback_url` (`string`, optional): **The http(s) URL called once the job ends**, completed or failed. We will do a POST request of the ASSET_JOB_FINALIZED event on this URL with a JSON payload. Example: https://example.com/webhooks/abyssale.
- `model` (`string`, optional): The AI model to use, by id — one listed by GET /ai-models?operation=images_upscale. Omitted, the workspace's default is used. An id that is not an upscale model answers 400. Example: bria-rmbg-2.
- `upscale_factor` (`string`, optional): How many times larger the result is, on each side — one of the model's upscale_factors.allowed in GET /ai-models?operation=images_upscale, as a number (2) or as listed ("2"). Omitted, the model's default. Another value answers 400 unknown_enum_value with the accepted ones in errors[].expected. Example: 2.

Example input: `{"image_url":"<image_url>"}`

### `abyssale_media_generate`

Generate Multi-Format Media · Write

Start an asynchronous generation of several formats of a design: images, MP4 videos, GIFs, HTML5 banners or print PDFs.
Returns a generation_request_id; results arrive on callback_url or by polling.
Poll abyssale_generation_request_get. Uses generation credits. Use abyssale_multipage_pdf_generate for printer_multipage designs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `callback_url` (`string`, optional): **The url that will be called once generation of your images is done.** We will do a POST request of the NewBannerBatch event on this URL with a JSON payload. Example: https://example.com/webhooks/abyssale.
- `elements` (`object`, optional): Element overrides keyed by layer name, from abyssale_design_get. Each value is an object of properties for that layer, such as payload and color for text, image_url for images, background_color for root. Image elements may also use AI properties (text to image, background removal, expand, upscale) here. Example: {"title": {"payload": "Summer sale - 40% off", "color": "#111111"}, "product-image": {"image_url": "https://example.com/product.jpg"}}
- `file_compression_level` (`integer`, optional): Output quality, 1-100 — 100 is the best quality (least compression), 1 the smallest file. Despite the name, higher = better. Example: 10.
- `file_name` (`string`, optional): File name of the generated visual, without extension — returned as file.filename. Replaces the file naming set in the design settings and accepts the same properties: {format_name}, {format_width}, {format_height}, {template_name}, {template_id}, {file_id}, {creation_timestamp} and {layer_name.property} (e.g. {title.payload}). 1–255 characters. Punctuation other than - and _, control characters and characters outside Latin-1 are removed, and a name longer than 255 characters once its properties are replaced is cut at 255; if nothing is left, the design's naming applies. With several formats, include {format_name} so the files do not share a name. The name is a label, not a key: it never changes the file's url, and several visuals may share it. An export stores each visual under it and adds -1, -2… to repeated names. Example: {template_name}-{format_name}
- `gif` (`object`, optional): GIF output options (animated designs only). Example: {}
- `html5` (`object`, optional): HTML5 output options (animated designs only). Example: {}
- `image_file_type` (`string`, optional): Output file type (auto ≡ omitted); must match the design type, else 400 invalid_filetype — static → jpeg/png/webp/avif/pdf, animated → mp4/gif/html5, print → pdf. When omitted: static → jpeg (png when the format background is transparent); animated → mp4; print → pdf. Example: png. One of: `png`, `jpeg`, `webp`, `avif`, `gif`, `pdf`, `html5`, `mp4`, `auto`.
- `original_visual_id` (`string`, optional): Regenerate an existing visual in place, keeping its share URL (visual versioning). The request must target exactly ONE format — combining this with more than one template_format_names entry answers 400 more_than_one_format. Unknown or unrelated visuals answer 404 (visual_not_found, not_related_to_same_template, not_related_to_same_format). Example: 3f2a1b0c-9d8e-4f7a-b6c5-d4e3f2a1b0c9.
- `print` (`object`, optional): Print output options (printer/printer_multipage designs only). Example: {}
- `template_format_names` (`array`, optional): **Format IDs you would like to generate**. _The array can be empty or not provided if you want to generate all formats of this design._. Example: ["facebook-post", "instagram-story"]
- `video` (`object`, optional): Video output options (animated designs only). Example: {}

Example input: `{"design_id":"<design_id>"}`

### `abyssale_multipage_pdf_generate`

Generate Multi-Page PDF · Write

Start an asynchronous generation of one multi-page print PDF from a printer_multipage design, with element overrides per page.
Returns a generation_request_id; the PDF link arrives on callback_url or by polling.
Poll abyssale_generation_request_get. Uses generation credits.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
- `pages` (`object`, required): Element overrides per page, keyed page_1 to page_N. Each value is an object of element overrides for that page, in the same shape as elements on the other generation tools. Example: {"page_1": {"title": {"payload": "Spring catalog"}}, "page_2": {"title": {"payload": "New arrivals"}}}
- `callback_url` (`string`, optional): **The url that will be called once generation of your PDF is done.** We will do a POST request of the NewBannerBatch event on this URL with a JSON payload. Example: https://example.com/webhooks/abyssale.
- `file_name` (`string`, optional): File name of the generated PDF, without extension — returned as file.filename. Applies to the whole document. Replaces the file naming set in the design settings and accepts the same properties: {template_name}, {template_id}, {file_id}, {creation_timestamp}, {layer_name.property} (e.g. {title.payload}), and {format_name}, {format_width}, {format_height}, which take the values of the first page. 1–255 characters. Punctuation other than - and _, control characters and characters outside Latin-1 are removed, and a name longer than 255 characters once its properties are replaced is cut at 255; if nothing is left, the design's naming applies. The name is a label, not a key: it never changes the file's url, and several visuals may share it. An export stores each visual under it and adds -1, -2… to repeated names. Example: {template_name}-{format_name}
- `print` (`object`, optional): Print output options. Example: {}

Example input: `{"design_id":"<design_id>","pages":{}}`

### `abyssale_project_create`

Create Project · Write

Create a project to organize designs.
Returns the created project with its id.
Only designs that belong to a project are reachable through the API.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the project. Example: Summer sale.

Example input: `{"name":"<name>"}`

### `abyssale_workspace_template_use`

Use Workspace Template · Write

Duplicate a workspace template into a project, creating an editable design.
Returns a duplication_request_id; the copy is made asynchronously.
Poll abyssale_duplication_request_get for the new design.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `company_template_id` (`string`, required): ID (UUID) of the workspace template. Get it from abyssale_workspace_templates_list. Example: 7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a.
- `project_id` (`string`, required): Target project ID where the template will be duplicated. Example: 9d1f2b7c-5a44-4c3e-9f21-0b8e6d4a1c73.
- `name` (`string`, optional): Optional custom name for the duplicated template. Example: Summer sale.

Example input: `{"company_template_id":"<company_template_id>","project_id":"<project_id>"}`

### `abyssale_design_delete`

Delete Design · Destructive

Permanently delete a design. There is no restore; files already generated from it are kept.
Returns no content on success.
Use abyssale_design_as_import_get first to keep a copy of the design.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `design_id` (`string`, required): ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.

Example input: `{"design_id":"<design_id>"}`

## Related

Other Design connectors ([all 34](/agentkit/connectors/?category=design)):

- [Figma](/agentkit/connectors/figma/): Scalekit connector, OAuth, 54 tools
- [Miro](/agentkit/connectors/miro/): Scalekit connector, OAuth, 115 tools
- [Mural](/agentkit/connectors/mural/): Scalekit connector, OAuth, 61 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
