Abyssale

Shows how many generation credits (image/video renders) and AI credits (text-to-image, remove-background, etc.) this workspace has left this billing period.

get_remaining_credits

Create a design (or workspace template) from a JSON structure — the same shape get_design_as_import returns and POST /designs/import/json accepts: {name, type: static|printer|animated|printer_multipage, target?: {kind: design|workspace_template, project_uuid}, formats/layers (or pages for printer_multipage), ...}. HOW TO SUPPLY AN IMAGE — four options, in order of preference. Use the first one you can actually reach, and do not settle for a later one without ruling out the earlier ones. (1) An already-hosted https URL — atomic and free: Abyssale fetches it, there is no upload step and no second round-trip. Prefer this whenever the image is already online or the user can give you a link to it. (2) An inline data URI, 'data:image/png;base64,<payload>' — also atomic: it is decoded and stored during this same call, so again no upload step. Keep inlined images to 100 KB or less. Base64 costs roughly bytes/2.2 in tokens, so 100 KB is already ~45k; larger payloads are accepted but are far past what is worth spending on one asset. Over 100 KB, use (1) or (3) instead — or, when neither is reachable, recompress the image to fit. Never re-encode, downscale or recompress silently: tell the user what you changed, with the before and after (e.g. '320 KB source, recompressed to ~17 KB at quality 60'). The design keeps whatever you send, so a quality trade outlives the conversation and the user has to know it happened. Shrinking is often fine, especially for a photo shown far smaller than its source; when the original's quality matters more, (1) or (3) keep it exactly. (3) A bare filename, for a file on the user's machine — this is the only option that is NOT atomic: it comes back as WAITING_FOR_VALIDATION with one ready-to-run curl command per layer. Run each one yourself, substituting the real local path, then call check_design_import_status; the import proceeds by itself once the files land. Pick this only if you can execute shell commands on the machine holding the file. (4) If you cannot run a shell, don't hand the user the curl commands as a manual chore. Instead, ask the user for a hosted https URL of the image (1), or use (2), recompressing the image to fit 100 KB and telling them so. One upload is planned per LAYER, so every format of a layer must name the same file — multiple distinct filename srcs on one layer are rejected, so use https URLs for per-format src variation. Image and logo layers accept any image/* type; the stored file is extensionless because the pipeline sniffs magic bytes, so the data URI's declared mimetype does not have to be exact. IMPORTANT — flat vs format-keyed layout/properties: a single-format design may send either shape (flat, or keyed by its one format name or 'default'), but a MULTI-format design MUST key every layer's layout/properties by format name — flat becomes invalid the moment a second format is added. A single-format worked example cannot teach this rule, since flat happens to validate there either way — check get_design_as_import's own payload shape for the design's actual format count before assuming flat is safe. One real layer, trimmed to 2 of its 12 formats, showing the keyed shape: {"name":"image_bg","type":"image","layout":{"linkedin-square":{"x":0,"y":0,"width":1200,"height":1200},"facebook-post":{"x":0,"y":0,"width":1200,"height":1200}},"properties":{"default":{"filter_name":"duotone","filter_properties":{"name":"deep_purple_beige"}},"linkedin-square":{"src":"https://.../image.jpeg","fitting_type":"fill","alignment":"top left"},"facebook-post":{"src":"https://.../image.jpeg","fitting_type":"fill","alignment":"top left"}}}. Full real worked examples (one per design type, downloaded from Abyssale's own docs, not hand-written) are available as resources at abyssale://design-import-examples/{static, static-multi-format, animated, animated-video, printer, printer-multipage} if this client supports reading resources, and at https://developers.abyssale.com/rest-api/designs/import/examples either way. By default this waits internally for up to about 60 seconds and returns the finished result directly if it lands within that window. If it's still not done after that, you get back import_id with is_finalized: false — tell the user it's taking longer than usual and use check_design_import_status with that id to check again later. Pass wait_for_result: false to skip the internal wait entirely and get the id back immediately.

import_design_from_json

List the designs in the user's Abyssale workspace, most recently edited first unless `sort` says otherwise. Use this to browse what exists, or to obtain a design id — the generation tools need an id, not a name. If the user already described which design they want by name, prefer search_designs. Only designs the signed-in user can open are listed: designs in private projects they are not a member of are excluded. Shared workspace templates are NOT designs and are not listed — they must be copied into the workspace before they can be generated. A design that is not in a project, or whose project was deleted, is not listed. Drafts are not listed; only finished designs are.

list_designs

List fonts available for text and button elements. There are roughly 1149 Google Fonts (always available, every workspace) plus this company's own custom uploads (few, workspace-specific) — omitting `type` returns both kinds mixed together. Prefer filtering over browsing: paging through ~1149 entries to find one font is slow and wastes context. Filter by `name` (exact names rank first), by `category` for a style ("an elegant serif", "something handwritten"), by `weight` for a weight and by `style` for italic — "bold" is weight 700 and "italic" is style italic, not part of a name. Render italic with text markup in the payload: <w=italic>…</w>, or <w=700-italic>…</w> for bold italic. The `id` this returns is the value to set under elements.<layer_name>.font when calling generate_static_banner or generate_banners_async on a text or button layer — get_design/get_design_format show which layers are text/button but do not enumerate font choices; this tool is where those come from.

list_fonts

List the projects (campaigns/folders that group designs) in the user's Abyssale workspace, in alphabetical order by name. Use this to find a project's id, then pass it as project_id to search_designs or list_designs, or just to answer 'what projects do I have'. Only projects the signed-in user can open are listed — projects they are not a member of are excluded, same as list_designs' own visibility rule.

list_projects

Look up the current values, layout and overridable attributes for ONE format of a design, flattened (not a map keyed by format). Use get_design first to see which formats and layers exist; use this tool once you've picked a format_specifier to see its concrete current state before overriding anything with generate_static_banner. printer_multipage designs have no formats — expect format_not_found for any format_specifier on one of those.

get_design_format

Look up who you're signed in as and which Abyssale workspace you're working in.

get_me

Move one design to another project in the user's Abyssale workspace. The design keeps its id, content and generated banners; its review/approval status is reset. Moving it to the project it is already in changes nothing. Requires a role that can manage designs (owner, admin, manager or designer) and access to both the design's current project and the destination; a destination the user cannot open is reported as project_not_found.

move_design

Rename a design in the user's Abyssale workspace. Only the name changes — layers, formats and generated banners are untouched. Name must be 1-100 characters (surrounding spaces are removed). Requires a role that can manage designs (owner, admin, manager or designer) and access to the design's project; a design the user cannot open is reported as not found.

rename_design

Find designs when the user describes which one they want — 'the black friday banner', 'my instagram design', 'the summer sale story'. Use `query` first: its words are matched in any order, each in the design name or the project (campaign/folder) name, ignoring case and the hyphens or underscores names are written with. `name` and `project` are strict filters for one exact phrase in that one field. Results are most recently edited first unless `sort` says otherwise. Returns design ids, which the generation tools require. Use list_designs instead to browse without a search term.

search_designs