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.

media

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.

7 functions 6 read 1 write Bearer token auth

Submit Abyssale feedback View package source

Abyssale CLI Setup

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

# 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: Bearer token bearer_token. Configure credentials once, then use the same stored profile from scripts, coding CLIs, Lua code mode, and the MCP gateway.

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

Call Abyssale Headlessly

Use the generic call form when another coding CLI or script needs a stable universal interface.

kosmo integrations:call abyssale.abyssale_list_generations '{
  "page": 1,
  "limit": 1,
  "status": "example_status"
}' --json

Use the provider shortcut form for shorter human-facing commands.

kosmo integrations:abyssale abyssale_list_generations '{
  "page": 1,
  "limit": 1,
  "status": "example_status"
}' --json

Agent Discovery Commands

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

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

All CLI Functions

Every function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to Abyssale.

`abyssale.abyssale_list_generations`

Read read

List image generation jobs from Abyssale. Returns a paginated list of generations, optionally filtered by status (e.g., "finished", "processing", "failed").

Parameters: page, limit, status

Generic CLI call

kosmo integrations:call abyssale.abyssale_list_generations '{"page":1,"limit":1,"status":"example_status"}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_list_generations '{"page":1,"limit":1,"status":"example_status"}' --json

`abyssale.abyssale_get_generation`

Read read

Get details of a specific image generation from Abyssale, including its status, output URLs, and applied modifications.

Parameters: id

Generic CLI call

kosmo integrations:call abyssale.abyssale_get_generation '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_get_generation '{"id":"example_id"}' --json

`abyssale.abyssale_create_generation`

Write write

Generate images from an Abyssale template. Specify the template, one or more output format IDs, and element modifications (text, images, colors) to customize the output.

Parameters: template_id, format_ids, modifications

Generic CLI call

kosmo integrations:call abyssale.abyssale_create_generation '{"template_id":"example_template_id","format_ids":"example_format_ids","modifications":"example_modifications"}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_create_generation '{"template_id":"example_template_id","format_ids":"example_format_ids","modifications":"example_modifications"}' --json

`abyssale.abyssale_list_templates`

Read read

List available design templates from Abyssale. Returns a paginated list of templates with their IDs and names.

Parameters: page, limit

Generic CLI call

kosmo integrations:call abyssale.abyssale_list_templates '{"page":1,"limit":1}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_list_templates '{"page":1,"limit":1}' --json

`abyssale.abyssale_get_template`

Read read

Get details of a specific Abyssale template, including its available formats, elements, and layers that can be modified.

Parameters: id

Generic CLI call

kosmo integrations:call abyssale.abyssale_get_template '{"id":"example_id"}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_get_template '{"id":"example_id"}' --json

`abyssale.abyssale_list_formats`

Read read

List available output formats from Abyssale. Formats define the size and dimensions of generated images (e.g., 1200x628 Facebook post, 1080x1080 Instagram square).

Parameters: page, limit

Generic CLI call

kosmo integrations:call abyssale.abyssale_list_formats '{"page":1,"limit":1}' --json

Provider shortcut

kosmo integrations:abyssale abyssale_list_formats '{"page":1,"limit":1}' --json

`abyssale.abyssale_get_current_user`

Read read

Get the profile of the currently authenticated Abyssale user. Useful for verifying API credentials and retrieving account information.

Parameters: none

Generic CLI call

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

Provider shortcut

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

Function Schemas

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

`abyssale.abyssale_list_generations`

List image generation jobs from Abyssale. Returns a paginated list of generations, optionally filtered by status (e.g., "finished", "processing", "failed").

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_list_generations --json

Parameter	Type	Required	Description
`page`	integer	no	Page number (1-based, default: 1).
`limit`	integer	no	Results per page (default: 20, max: 100).
`status`	string	no	Filter by generation status: "finished", "processing", or "failed".

`abyssale.abyssale_get_generation`

Get details of a specific image generation from Abyssale, including its status, output URLs, and applied modifications.

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_get_generation --json

Parameter	Type	Required	Description
`id`	string	yes	The generation UUID.

`abyssale.abyssale_create_generation`

Generate images from an Abyssale template. Specify the template, one or more output format IDs, and element modifications (text, images, colors) to customize the output.

Operation: Write write
Schema command: kosmo integrations:schema abyssale.abyssale_create_generation --json

Parameter	Type	Required	Description
`template_id`	string	yes	The template UUID to generate from.
`format_ids`	array	yes	Array of format UUIDs to generate (e.g., ["fmt_abc123", "fmt_def456"]). Use abyssale_list_formats to discover available formats.
`modifications`	object	no	Element modifications as a JSON object. Keys are element names, values define overrides (e.g., {"title": {"payload": "New Headline"}, "background": {"payload": "https://example.com/bg.jpg"}}).

`abyssale.abyssale_list_templates`

List available design templates from Abyssale. Returns a paginated list of templates with their IDs and names.

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_list_templates --json

Parameter	Type	Required	Description
`page`	integer	no	Page number (1-based, default: 1).
`limit`	integer	no	Results per page (default: 20, max: 100).

`abyssale.abyssale_get_template`

Get details of a specific Abyssale template, including its available formats, elements, and layers that can be modified.

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_get_template --json

Parameter	Type	Required	Description
`id`	string	yes	The template UUID.

`abyssale.abyssale_list_formats`

List available output formats from Abyssale. Formats define the size and dimensions of generated images (e.g., 1200x628 Facebook post, 1080x1080 Instagram square).

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_list_formats --json

Parameter	Type	Required	Description
`page`	integer	no	Page number (1-based, default: 1).
`limit`	integer	no	Results per page (default: 20, max: 100).

`abyssale.abyssale_get_current_user`

Get the profile of the currently authenticated Abyssale user. Useful for verifying API credentials and retrieving account information.

Operation: Read read
Schema command: kosmo integrations:schema abyssale.abyssale_get_current_user --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.