Search Docs
Loading...
Skip to content

Quickstart: pi

Type a brief and get a finished PNG and an editable design file from a design agent on pi, in around 3 minutes, depending on the model and how hard the brief is.

12 mins
estimated time
Download
GitHub

To have a coding agent, such as Claude Code or Cursor, set up this kit for you, give it this prompt:

Open https://img.ly/docs/cesdk/codesign/starter-kits/quickstart-pi-cdsqpi.md
and set up this starter kit for me.

What It Does#

You run one command with a brief, such as “A square Instagram post for a spring sale on ceramic mugs”. An AI model designs it, looks at what it made, and improves it, then the kit writes two files:

  • out/design.png, a picture of the design.
  • out/design.imgly, the design itself with its images and fonts, which you can open and edit in CE.SDK’s web editor ( Your Editor). CE.SDK is IMG.LY’s design engine and editor.

Start from this kit if your product runs a design agent on its servers: a chat, a job queue, or an API. Two things run on your machine:

  • The executor, a Docker container from the image imgly/codesign-executor, which IMG.LY publishes. It holds CE.SDK’s engine and runs the short JavaScript programs the model writes to change the design, in its own container, apart from your keys and your data. You write no code for it.
  • The agent runner, design.mjs, the kit’s code and later yours. It gets the design tools from the CoDesign SDK, @imgly/codesign-sdk, and hands them to pi, a small agent library (@earendil-works/pi-agent-core). A tool is a function the model can ask to call, such as one that changes the design or renders a preview. pi runs the agent loop: it calls the model, runs each tool the model asks for, and sends the result back, until the model is done. Then the script exports the design.

The model runs through IMG.LY’s AI gateway, a service that forwards model calls to the model provider and charges them to your IMG.LY account, so you need no account with a model provider.

Pre-requisites#

  • Docker, to run the executor – Download
  • Node.js v22+ with npm, pnpm, or yarn – Download
  • A CoDesign license key. Contact sales to get a CoDesign license key. That one key starts the design engine, pays for each exported file, and pays for the model through the gateway.

Get Started#

Step 1: Clone the Repository#

Terminal 
git clone https://github.com/imgly/starterkit-codesign-quickstart-pi-js-node.git
git clone https://github.com/imgly/starterkit-codesign-quickstart-pi-js-node.git

What is inside:

starterkit-codesign-quickstart-pi-js-node/
├── design.mjs           # The agent runner: prepares the tools, hands them to pi, exports the design
├── .env.template        # The variables to copy into .env
├── README.md            # How to run the kit
├── LICENSE.md           # IMG.LY's license, the same as the CoDesign SDK's
├── package.json         # The SDK, pi's agent core, and its model layer, at exact versions; `npm run executor` starts the executor
├── tsconfig.json        # `npm run check` type-checks design.mjs
└── tsconfig.base.json   # The compiler settings tsconfig.json extends

Read design.mjs after your first run; How It Works below explains it.

Step 2: Install Dependencies#

Terminal 
cd starterkit-codesign-quickstart-pi-js-node
npm install
cd starterkit-codesign-quickstart-pi-js-node
npm install

package.json pins @imgly/codesign-sdk to the same version as the executor image’s tag in its executor script. Keep the two equal, because the SDK and the executor must come from the same build ( Versions and Upgrades).

Step 3: Set Your Keys#

Copy .env.template to .env and fill in one variable: IMGLY_CESDK_LICENSE holds your CoDesign license key (the variable keeps CE.SDK’s name). EXECUTOR_TOKEN, the token your runner and the executor share, is already filled in:

.env
IMGLY_CESDK_LICENSE=<your CoDesign license key>
EXECUTOR_TOKEN=codesign-quickstart-token

The executor script passes .env to the executor, and the start script to design.mjs, so the two always have the same token. Two optional variables are described in .env.template:

Variable What it is
MODEL The gateway’s model id. Default @openrouter/anthropic/claude-opus-5. The gateway lists its ids at https://gateway.img.ly/v1/models.
EXECUTOR_URL The executor’s address. Default http://localhost:8080.

Step 4: Start the Executor#

Terminal 
npm run executor
curl http://localhost:8080/health
npm run executor
curl http://localhost:8080/health

The executor script runs IMG.LY’s image in Docker with the variables from .env, on port 8080 of your machine only. The first start downloads the image. curl prints a line like this one:

{"result":{"sessions":0,"accepting":true,"bound":false,...}}

If /health does not answer, run docker logs codesign-executor to see why. The executor stops at start when the license key is missing or cannot be activated, or when it cannot reach api.img.ly.

Step 5: Design Something#

Terminal 
npm start – “A square Instagram post for a 20% spring sale on ceramic mugs. Calm, premium, lots of white space.”
npm start – “A square Instagram post for a 20% spring sale on ceramic mugs. Calm, premium, lots of white space.”

A run takes around 3 minutes, depending on the model and how hard the brief is. You see a line for each tool call as it happens, a ✓ and the tool’s name, as the model reads IMG.LY’s design rules, changes the design, and looks at a render, a picture of the design. Then you see the model’s one-sentence summary and a line with the number of steps, the seconds, and the tokens used. The last line is:

Wrote out/design.png and out/design.imgly

Open out/design.png to see the design. out/design.imgly opens in CE.SDK’s web editor, which you embed in a page of your product ( Your Editor). Use exactly the CE.SDK version the executor runs, which the SDK exports as CESDK_VERSION: an older or newer editor that saves the file drops what the other version wrote ( Versions and Upgrades).

To stop and remove the executor, run npm run executor:stop.

Run It Again#

The executor serves one conversation: your id for one chat or job, which design.mjs sets to quickstart on every run. At the end of a run, the script calls release(), which closes the design on the executor. Half a minute later the executor exits, and Docker starts it again, ready for your next run.

A run that starts in the few seconds while the container restarts fails with executor_unreachable. Wait until curl http://localhost:8080/health answers again.

Before you run the executor anywhere but your machine, follow Host the Executor.

What It Costs#

Each run’s PNG export and the model’s tokens are charged to the IMG.LY account behind your key; the .imgly file, the edits, and the previews are free ( What It Costs).

How It Works#

design.mjs does five things. The excerpts below are from it, and the whole file follows them.

  1. It calls the model through IMG.LY’s gateway. The gateway at https://gateway.img.ly/v1 speaks OpenAI’s Chat Completions, the request format most model providers accept. Your license key is its API key; the getApiKey option of new Agent, in the whole file below, returns it. pi reaches the gateway through the model entry with api: 'openai-completions'.
    • cost is 0 because the gateway does the billing, so pi reports no cost of its own.
    • reasoning, contextWindow, and maxTokens here, and thinkingLevel in new Agent, are pi’s usual model settings; change them for another model.
// IMG.LY's AI gateway speaks OpenAI's Chat Completions; your CoDesign license key is its API key.
/** @type {import('@earendil-works/pi-ai').Model<'openai-completions'>} */
const model = {
  id: process.env.MODEL || '@openrouter/anthropic/claude-opus-5',
  name: 'Design model through IMG.LY',
  api: 'openai-completions',
  provider: 'imgly-gateway', // any name; pi only labels with it
  baseUrl: 'https://gateway.img.ly/v1',
  reasoning: true,
  input: ['text', 'image'], // tool results carry renders of the design
  cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 }, // the gateway bills; pi's estimate stays 0
  contextWindow: 1_000_000,
  maxTokens: 16_000
};
  1. It prepares the tools with prepareCoDesign.
    • conversation is your id for the work. Every design of a conversation opens on one executor that serves no other conversation, because the model’s code runs there; see Security.
    • executors: remoteExecutors({ acquire, token }) says where a conversation’s executor is. acquire is a function you write. Here it always answers the container on port 8080. In production, it answers a new container for each new conversation, and the same one while the conversation lasts.
    • plugins lists the CE.SDK plugins the engine applies. A plugin adds asset sources: searchable lists of what a design can use, such as photos, typefaces, and colors. googleFonts() is IMG.LY’s Google Fonts catalog, the smallest useful list.
    • design is the id of the design the tools work on. With no designs store, the design lives in the runner’s memory for the run.
    • gateway: false leaves out image generation. The model still runs through the gateway. The option is required, so you decide.
const codesign = prepareCoDesign({
  // Your id for this job. Every design of a conversation opens on one executor
  // that serves no other conversation. Every run here is yours, so all share one.
  conversation: 'quickstart',
  executors: remoteExecutors({
    // The executor for a conversation. Here there is one; a product starts a
    // new one for each conversation.
    acquire: () => ({
      url: process.env.EXECUTOR_URL || 'http://localhost:8080'
    }),
    token: process.env.EXECUTOR_TOKEN
  }),
  // The CE.SDK plugins the engine applies: everything the agent can search and
  // place. Google Fonts is the smallest useful list; your own plugins go here.
  plugins: [googleFonts()],
  design: `quickstart-${Date.now()}`, // any id; with no `designs` store, the design lives in memory
  gateway: false // no image generation; the model still runs through the gateway
});
  1. It hands the tools to pi. Each SDK tool is { name, description, inputSchema, call }, with a JSON Schema as inputSchema; pi types it as a schema of TypeBox, a JSON Schema library, which is JSON Schema too. The mapping to pi’s tool shape passes the content of each result unchanged. A failed call is thrown, so pi reports it to the model as a failed call.
// The SDK's tools in pi's shape. pi moves renders out of tool results itself,
// so the model sees its work on Chat Completions too.
const tools = codesign.tools.map((t) => ({
  name: t.name,
  label: t.name,
  description: t.description ?? '',
  parameters:
    /** @type {import('@earendil-works/pi-agent-core').AgentTool['parameters']} */ (
      t.inputSchema
    ), // plain JSON Schema; pi types it as TypeBox's
  execute: async (_id, params, signal) => {
    const result = await t.call(params ?? {}, { signal });
    if (result.isError)
      throw new Error(
        result.content.map((p) => (p.type === 'text' ? p.text : '')).join('\n')
      ); // the model reads it as a failed call
    return { content: result.content, details: {} };
  }
}));
  1. It lets the model see its renders. Chat Completions allows no images inside a tool result. pi moves each render into a user message itself, so the script needs no step for it. input: ['text', 'image'] tells pi that the model accepts images.
  2. It adds codesign.instructions to the end of your own prompt and runs the agent.
    • The instructions tell the model how to use the tools, so your prompt names none of them.
    • If you add pi’s convertToLlm option, a filter over the messages pi sends to the model, keep the system message. pi sends the system prompt and the tools in it; without it the model gets neither, with no error.
    • pi does not throw when the gateway refuses a call, so the script checks the last message for an error first. Then it exports the PNG and the .imgly file and calls release().

The script sets no step limit: pi runs until the model stops. To bound a run’s cost in your product, count the tool_execution_end events and call agent.abort() past a limit of yours, or after a time limit.

The whole file
design.mjs
// A brief in, a finished design out: pi runs the model through IMG.LY's gateway, the engine runs in one local executor.
import { mkdir, writeFile } from 'node:fs/promises';


import { Agent } from '@earendil-works/pi-agent-core';
import { streamSimple } from '@earendil-works/pi-ai/compat';
import {
  googleFonts,
  prepareCoDesign,
  remoteExecutors
} from '@imgly/codesign-sdk';


const brief = process.argv[2];
const missing = [
  ...(brief ? [] : ['a brief (the first argument)']),
  ...['IMGLY_CESDK_LICENSE', 'EXECUTOR_TOKEN'].filter((n) => !process.env[n])
];
if (missing.length > 0) {
  console.error(
    `Missing ${missing.join(', ')}.\nUsage: npm start -- "<brief>", with the variables of .env.template set in .env` +
      (process.env.IMGLY_CESDK_LICENSE
        ? ''
        : '\nContact sales (https://img.ly/forms/contact-sales/) to get a CoDesign license key.')
  );
  process.exit(1);
}


// IMG.LY's AI gateway speaks OpenAI's Chat Completions; your CoDesign license key is its API key.
/** @type {import('@earendil-works/pi-ai').Model<'openai-completions'>} */
const model = {
  id: process.env.MODEL || '@openrouter/anthropic/claude-opus-5',
  name: 'Design model through IMG.LY',
  api: 'openai-completions',
  provider: 'imgly-gateway', // any name; pi only labels with it
  baseUrl: 'https://gateway.img.ly/v1',
  reasoning: true,
  input: ['text', 'image'], // tool results carry renders of the design
  cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 }, // the gateway bills; pi's estimate stays 0
  contextWindow: 1_000_000,
  maxTokens: 16_000
};


const codesign = prepareCoDesign({
  // Your id for this job. Every design of a conversation opens on one executor
  // that serves no other conversation. Every run here is yours, so all share one.
  conversation: 'quickstart',
  executors: remoteExecutors({
    // The executor for a conversation. Here there is one; a product starts a
    // new one for each conversation.
    acquire: () => ({
      url: process.env.EXECUTOR_URL || 'http://localhost:8080'
    }),
    token: process.env.EXECUTOR_TOKEN
  }),
  // The CE.SDK plugins the engine applies: everything the agent can search and
  // place. Google Fonts is the smallest useful list; your own plugins go here.
  plugins: [googleFonts()],
  design: `quickstart-${Date.now()}`, // any id; with no `designs` store, the design lives in memory
  gateway: false // no image generation; the model still runs through the gateway
});


// The SDK's tools in pi's shape. pi moves renders out of tool results itself,
// so the model sees its work on Chat Completions too.
const tools = codesign.tools.map((t) => ({
  name: t.name,
  label: t.name,
  description: t.description ?? '',
  parameters:
    /** @type {import('@earendil-works/pi-agent-core').AgentTool['parameters']} */ (
      t.inputSchema
    ), // plain JSON Schema; pi types it as TypeBox's
  execute: async (_id, params, signal) => {
    const result = await t.call(params ?? {}, { signal });
    if (result.isError)
      throw new Error(
        result.content.map((p) => (p.type === 'text' ? p.text : '')).join('\n')
      ); // the model reads it as a failed call
    return { content: result.content, details: {} };
  }
}));


const agent = new Agent({
  initialState: {
    systemPrompt: `You design marketing visuals. When you are done, say in one sentence what you made.\n\n${codesign.instructions}`,
    model,
    thinkingLevel: 'medium',
    tools
  },
  // No convertToLlm filter: pi sends the system prompt and the tools as a system message, and a filter that drops it sends neither.
  streamFn: streamSimple,
  getApiKey: () => process.env.IMGLY_CESDK_LICENSE
});
agent.subscribe((e) => {
  if (e.type === 'tool_execution_end')
    console.log(`${e.isError ? '✗' : '✓'} ${e.toolName}`);
});


const started = Date.now();
await agent.prompt(brief);
const last = agent.state.messages.at(-1);
const seconds = Math.round((Date.now() - started) / 1000);
// pi does not throw when the gateway refuses (402 when the credits run out): the error is in the last message.
if (last?.role !== 'assistant' || last.stopReason === 'error') {
  console.error(
    `The run ended with an error after ${seconds} s: ${last?.role === 'assistant' ? last.errorMessage : 'no answer'}; nothing exported.`
  );
  process.exitCode = 1;
} else {
  console.log(
    `\n${last.content
      .filter((p) => p.type === 'text')
      .map((p) => p.text)
      .join('')}`
  );
  const answers = agent.state.messages.filter((m) => m.role === 'assistant');
  const usage = (key) => answers.reduce((sum, m) => sum + m.usage[key], 0);
  const input = usage('input') + usage('cacheRead') + usage('cacheWrite');
  console.log(
    `${answers.length} steps, ${seconds} s, ${input} input / ${usage('output')} output tokens`
  );
  await mkdir('out', { recursive: true });
  await writeFile('out/design.png', await codesign.export('png'));
  await writeFile('out/design.imgly', await codesign.export('imgly'));
  console.log('Wrote out/design.png and out/design.imgly');
}
await codesign.release(); // ends the design's session now; the engine closes about 30 s later

What to Replace#

Piece In the kit In your product
The agent runner design.mjs, run once from a terminal with a brief your server or job, with any agent framework, on the gateway with your license key
The tools codesign.tools the same
The executor one container from npm run executor, shared by every run IMG.LY’s executor image, a new container for each conversation, answered by acquire
The design the runner’s memory, then two files in out/ your database, through designs ( Connect Your Storage)
Fonts and media googleFonts() your own CE.SDK plugin in plugins ( Bring Your Brand)

To grow the script into your product:

  • To start from a customer’s file, such as a Photoshop file (PSD), a PDF, or an .imgly file, call codesign.load(bytes) before the model runs.
  • To let the model hand files to a person, pass uploadExport: a function that stores an exported file and answers where the person gets it.
  • To let the model generate images, pass gateway: { bearer }, a function that returns your key.

For each of these options, see the API Reference.

Troubleshooting#

The Executor Does Not Start#

  • docker: open .env: no such file or directory. Copy .env.template to .env in the kit’s folder and set your key.
  • The container name "/codesign-executor" is already in use. The executor is already running: check curl http://localhost:8080/health, or run npm run executor:stop first.
  • /health does not answer. Run docker logs codesign-executor. The executor stops at start when the license key is missing or cannot be activated, or when it cannot reach api.img.ly.

The Run Fails#

  • node: .env: not found. Copy .env.template to .env in the kit’s folder.
  • Missing a brief (the first argument). Pass the brief after the command, in quotes, as in step 5.
  • Missing IMGLY_CESDK_LICENSE, EXECUTOR_TOKEN. Set both in .env.
  • missing or wrong executor token. The executor answered 401: it was started with another EXECUTOR_TOKEN. After you change the token, run npm run executor:stop and npm run executor again, so the executor gets it.
  • executor_unreachable. The executor is not running, or the run started while it restarts after the last run. Wait until curl http://localhost:8080/health answers.
  • The gateway answers 402 insufficient_credits. The account behind the key is out of credits. The script prints The run ended with an error after … s with the gateway’s message, and exports nothing.
  • The run ended with an error with another message. The model call failed for the reason the message names. Nothing was exported.

For more failures and their fixes, see Troubleshooting.

Next Steps#