Can I use Abyssale as a CLI?

Yes. KosmoKrator exposes a Abyssale CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Abyssale through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Abyssale tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Abyssale credentials stored?

Abyssale credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Abyssale MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

rendering

Abyssale CLI for AI Agents

Use the Abyssale CLI from KosmoKrator to call Abyssale tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Abyssale CLI Setup

Abyssale can be configured headlessly with `kosmokrator integrations:configure abyssale`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure abyssale --set access_token="$ABYSSALE_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor abyssale --json
kosmokrator integrations:status --json

Credentials

Authentication type: api key header api_key_header. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`access_token`	`ABYSSALE_ACCESS_TOKEN`	Secret `secret`	yes	API Key
`url`	`ABYSSALE_URL`	URL `url`	no	API Base URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call abyssale.abyssale_api_get '{"path":"example_path","params":"example_params"}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_api_get '{"path":"example_path","params":"example_params"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs abyssale --json
kosmo integrations:docs abyssale.abyssale_api_get --json
kosmo integrations:schema abyssale.abyssale_api_get --json
kosmo integrations:search "Abyssale" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`abyssale.abyssale_api_get`

Call a documented Abyssale GET API path. Prefer named tools when one exists.

Read read

Parameters: path, params

Generic call

kosmo integrations:call abyssale.abyssale_api_get '{"path":"example_path","params":"example_params"}' --json

Shortcut

kosmo integrations:abyssale abyssale_api_get '{"path":"example_path","params":"example_params"}' --json

`abyssale.abyssale_api_post`

Call a documented Abyssale POST API path. Prefer named tools when one exists.

Read read

Parameters: path, payload

Generic call

kosmo integrations:call abyssale.abyssale_api_post '{"path":"example_path","payload":"example_payload"}' --json

Shortcut

kosmo integrations:abyssale abyssale_api_post '{"path":"example_path","payload":"example_payload"}' --json

`abyssale.abyssale_create_banner_export`

Create an asynchronous ZIP export for generated Abyssale files.

Write write

Parameters: ids, callback_url

Generic call

kosmo integrations:call abyssale.abyssale_create_banner_export '{"ids":"example_ids","callback_url":"example_callback_url"}' --json

Shortcut

kosmo integrations:abyssale abyssale_create_banner_export '{"ids":"example_ids","callback_url":"example_callback_url"}' --json

`abyssale.abyssale_create_dynamic_image_url`

Create or retrieve a dynamic image URL for an Abyssale design.

Write write

Parameters: design_id, enable_rate_limit, enable_production_mode

Generic call

kosmo integrations:call abyssale.abyssale_create_dynamic_image_url '{"design_id":"example_design_id","enable_rate_limit":true,"enable_production_mode":true}' --json

Shortcut

kosmo integrations:abyssale abyssale_create_dynamic_image_url '{"design_id":"example_design_id","enable_rate_limit":true,"enable_production_mode":true}' --json

`abyssale.abyssale_create_project`

Create a project in the Abyssale workspace.

Write write

Parameters: name

Generic call

kosmo integrations:call abyssale.abyssale_create_project '{"name":"example_name"}' --json

Shortcut

kosmo integrations:abyssale abyssale_create_project '{"name":"example_name"}' --json

`abyssale.abyssale_duplicate_workspace_template`

Duplicate a workspace template into a project.

Write write

Parameters: company_template_id, project_id, name

Generic call

kosmo integrations:call abyssale.abyssale_duplicate_workspace_template '{"company_template_id":"example_company_template_id","project_id":"example_project_id","name":"example_name"}' --json

Shortcut

kosmo integrations:abyssale abyssale_duplicate_workspace_template '{"company_template_id":"example_company_template_id","project_id":"example_project_id","name":"example_name"}' --json

`abyssale.abyssale_generate_image`

Synchronously generate a single image from a static Abyssale design.

Read read

Parameters: design_id, elements, template_format_name

Generic call

kosmo integrations:call abyssale.abyssale_generate_image '{"design_id":"example_design_id","elements":"example_elements","template_format_name":"example_template_format_name"}' --json

Shortcut

kosmo integrations:abyssale abyssale_generate_image '{"design_id":"example_design_id","elements":"example_elements","template_format_name":"example_template_format_name"}' --json

`abyssale.abyssale_generate_multi_format_media`

Asynchronously generate one or more formats from an Abyssale design.

Read read

Parameters: design_id, elements, template_format_names, callback_url

Generic call

kosmo integrations:call abyssale.abyssale_generate_multi_format_media '{"design_id":"example_design_id","elements":"example_elements","template_format_names":"example_template_format_names","callback_url":"example_callback_url"}' --json

Shortcut

kosmo integrations:abyssale abyssale_generate_multi_format_media '{"design_id":"example_design_id","elements":"example_elements","template_format_names":"example_template_format_names","callback_url":"example_callback_url"}' --json

`abyssale.abyssale_generate_multi_page_pdf`

Asynchronously generate a multi-page PDF from an Abyssale design.

Read read

Parameters: design_id, pages, callback_url

Generic call

kosmo integrations:call abyssale.abyssale_generate_multi_page_pdf '{"design_id":"example_design_id","pages":"example_pages","callback_url":"example_callback_url"}' --json

Shortcut

kosmo integrations:abyssale abyssale_generate_multi_page_pdf '{"design_id":"example_design_id","pages":"example_pages","callback_url":"example_callback_url"}' --json

`abyssale.abyssale_get_design`

Get an Abyssale design with its metadata, formats, and editable elements.

Read read

Parameters: design_id

Generic call

kosmo integrations:call abyssale.abyssale_get_design '{"design_id":"example_design_id"}' --json

Shortcut

kosmo integrations:abyssale abyssale_get_design '{"design_id":"example_design_id"}' --json

`abyssale.abyssale_get_design_format`

Get details for a specific format inside an Abyssale design.

Read read

Parameters: design_id, format_specifier

Generic call

kosmo integrations:call abyssale.abyssale_get_design_format '{"design_id":"example_design_id","format_specifier":"example_format_specifier"}' --json

Shortcut

kosmo integrations:abyssale abyssale_get_design_format '{"design_id":"example_design_id","format_specifier":"example_format_specifier"}' --json

`abyssale.abyssale_get_duplication_request`

Get the status of a workspace-template duplication request.

Read read

Parameters: duplicate_request_id

Generic call

kosmo integrations:call abyssale.abyssale_get_duplication_request '{"duplicate_request_id":"example_duplicate_request_id"}' --json

Shortcut

kosmo integrations:abyssale abyssale_get_duplication_request '{"duplicate_request_id":"example_duplicate_request_id"}' --json

`abyssale.abyssale_get_file`

Get a generated Abyssale file by banner ID.

Read read

Parameters: banner_id

Generic call

kosmo integrations:call abyssale.abyssale_get_file '{"banner_id":"example_banner_id"}' --json

Shortcut

kosmo integrations:abyssale abyssale_get_file '{"banner_id":"example_banner_id"}' --json

`abyssale.abyssale_list_designs`

List Abyssale designs available to the API key.

Read read

Parameters: none

Generic call

kosmo integrations:call abyssale.abyssale_list_designs '{}' --json

Shortcut

kosmo integrations:abyssale abyssale_list_designs '{}' --json

`abyssale.abyssale_list_fonts`

List custom and Google fonts available to the Abyssale workspace.

Read read

Parameters: none

Generic call

kosmo integrations:call abyssale.abyssale_list_fonts '{}' --json

Shortcut

kosmo integrations:abyssale abyssale_list_fonts '{}' --json

`abyssale.abyssale_list_projects`

List projects in the Abyssale workspace.

Read read

Parameters: none

Generic call

kosmo integrations:call abyssale.abyssale_list_projects '{}' --json

Shortcut

kosmo integrations:abyssale abyssale_list_projects '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

abyssale.abyssale_api_get 2 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_api_get --json

Parameter	Type	Required	Description
`path`	string	yes	API path, for example /designs.
`params`	object	no	Query parameters.

abyssale.abyssale_api_post 2 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_api_post --json

Parameter	Type	Required	Description
`path`	string	yes	API path, for example /projects.
`payload`	object	no	JSON request body.

abyssale.abyssale_create_banner_export 2 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_create_banner_export --json

Parameter	Type	Required	Description
`ids`	array	yes	Generated banner/file IDs to export.
`callback_url`	string	no	Optional callback URL for the export completion payload.

abyssale.abyssale_create_dynamic_image_url 3 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_create_dynamic_image_url --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.
`enable_rate_limit`	boolean	no	Enable per-query rate limiting for the dynamic image.
`enable_production_mode`	boolean	no	Enable production mode for the dynamic image.

abyssale.abyssale_create_project 1 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_create_project --json

Parameter	Type	Required	Description
`name`	string	yes	Project name, 2 to 100 characters.

abyssale.abyssale_duplicate_workspace_template 3 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_duplicate_workspace_template --json

Parameter	Type	Required	Description
`company_template_id`	string	yes	Workspace template UUID.
`project_id`	string	yes	Target project UUID.
`name`	string	no	Optional custom name for the duplicated design.

abyssale.abyssale_generate_image 3 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_generate_image --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.
`elements`	object	yes	Element overrides keyed by layer name.
`template_format_name`	string	no	Optional format name when the design has multiple formats.

abyssale.abyssale_generate_multi_format_media 4 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_generate_multi_format_media --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.
`elements`	object	yes	Element overrides keyed by layer name.
`template_format_names`	array	no	Format names to generate. Omit or pass an empty array for all formats.
`callback_url`	string	no	Optional callback URL for the completed generation payload.

abyssale.abyssale_generate_multi_page_pdf 3 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_generate_multi_page_pdf --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.
`pages`	object	no	Page overrides keyed by page or layer name.
`callback_url`	string	no	Optional callback URL for the completed PDF payload.

abyssale.abyssale_get_design 1 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_get_design --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.

abyssale.abyssale_get_design_format 2 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_get_design_format --json

Parameter	Type	Required	Description
`design_id`	string	yes	The Abyssale design UUID.
`format_specifier`	string	yes	The format ID or format name.

abyssale.abyssale_get_duplication_request 1 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_get_duplication_request --json

Parameter	Type	Required	Description
`duplicate_request_id`	string	yes	Duplication request UUID.

abyssale.abyssale_get_file 1 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_get_file --json

Parameter	Type	Required	Description
`banner_id`	string	yes	The generated banner/file UUID.

abyssale.abyssale_list_designs 0 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_list_designs --json

Parameter	Type	Required	Description
No parameters.

abyssale.abyssale_list_fonts 0 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_list_fonts --json

Parameter	Type	Required	Description
No parameters.

abyssale.abyssale_list_projects 0 parameters

Schema command

kosmo integrations:schema abyssale.abyssale_list_projects --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.