Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Abyssale

Scalekit connector
Open markdown

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.

Tools
32
What they doRead · write · destructive
17 · 14 · 117 read14 write1 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .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.

  4. Authorize a user and make your first call

    quickstart.mts
    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)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Abyssale credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • abyssale_ai_models_listList the AI models the workspace can use for each AI action, with the default model.Read-only

    List AI Models

    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.

    Inputs

    operationstring
    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_backgroundimages_text_to_imageimages_upscale
  • abyssale_api_key_verifyCheck that the API key works and find out which workspace it belongs to.Read-only

    Verify API Key

    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.

    Inputs

    This tool takes no inputs.

  • abyssale_asset_job_getGet the status of a background removal, text-to-image or upscale job.Read-only

    Get Asset Job

    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.

    Inputs

    job_idstringrequired
    job_id returned by abyssale_image_background_remove, abyssale_image_text_to_image or abyssale_image_upscale. Example: 8c9d0e1f-2a3b-4c5d-8e7f-9a0b1c2d3e4f.
  • abyssale_credits_getGet the workspace's remaining generation and AI credits for the current billing period.Read-only

    Get Remaining Credits

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

    Inputs

    This tool takes no inputs.

  • abyssale_design_as_import_getExport an existing design as the exact JSON body abyssale_design_import_create accepts (Alpha).Read-only

    Export Design as Import

    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.

    Inputs

    design_idstringrequired
    ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
  • abyssale_design_format_getGet one format of a design: dimensions, unit, preview URL, dynamic image URL, element layout and variables.Read-only

    Get Design Format

    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.

    Inputs

    design_idstringrequired
    ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
    format_specifierstringrequired
    Format name or UID of the design's format, from abyssale_design_get. Prefer the UID: it survives a rename. Example: facebook-post.
  • abyssale_design_getGet a design's full specification: formats with dimensions and previews, every configurable element with its properties, and template variables.Read-only

    Get Design

    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.

    Inputs

    design_idstringrequired
    ID (UUID) of the design. Get it from abyssale_designs_list. Example: 6b7e5f2a-1c3d-4e8f-9a0b-2c4d6e8f0a1b.
    detailstring
    Pass advanced to get the full layer and property set, including group layers that the default response leaves out. Example: advanced.one of advanced
  • abyssale_design_import_getGet the status of a JSON design import (Alpha).Read-only

    Get Design Import

    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.

    Inputs

    import_idstringrequired
    Import ID (UUID) returned by abyssale_design_import_create. Example: 4c5d6e7f-8a9b-4c0d-9e1f-2a3b4c5d6e7f.