Publishing your agent
Publish a workflow as an agent in the Publish studio, choose who can use it, write its pages and follow its listing status.
Publishing turns a workflow into an agent: a packaged version that people run from My agents without opening the canvas, and that can be added to other workflows as an agent flow. You can keep the agent to yourself, share it with people you choose, or list it for anyone in the Store and earn credits. You do all of it in one place, the Publish studio. See also Pricing & earnings and Publishing and updates.
Before you publish
- The workflow needs at least one neuron, and its flows can't have a loop: circular workflows can't be published as agents.
- An agent can have several actions. Each connected flow on the canvas becomes one action, named after the flow, and each neuron that isn't in a flow becomes an action of its own.
- Run each flow once in the canvas. Its last run becomes the example the studio shows on the agent's pages.
- Test the flows well: people run them with their own inputs. See Running.
- Decide what people see of each input. In each GET input, under People using the agent, choose Can change (they fill it in), Can see (they see your value but can't change it) or Hidden (they don't see it; your value is used). You can also set this on the studio's Agent page before you publish.
- In Memory › Settings, turn on Ships with the agent for each memory that should ship, and choose what a person's copy may learn. See Memory.
If something stops the workflow being published, the Publish button in the top bar is greyed out. Hover over it to see why.
Open the Publish studio
Click Publish in the canvas's top bar. The Publish as an agent studio opens.
- The left side holds the settings: who can use it, the Store page's category, the price and what ships with the agent.
- The right side is a live preview of the agent's pages. Switch between the Store page (when the agent is Shared or Public) and the Agent page.
- Choose Edit to change the pages in place: click any dashed text to change it. Choose Preview to see exactly what people will see.
Choose who can use it
Under WHO CAN USE IT, pick one:
- Only me: use it from My agents. It has no Store page and nobody else can find it.
- Shared with people: it has a Store page anyone with the link can see (search engines don't list it), but only people you add can use it. It isn't on the Store's home; only signed-in people find it on the Store (see Find an agent). Under People who can use it, type an email address and click Add for each person. The line under the box counts the people you've added, up to 50 people. An address that isn't an email is refused when you click Add ("Enter an email address, like [email protected]."), and Add is greyed out once the list is full. Leave Let others ask me for access from the Store page on so others can ask you; turn it off to keep it invite only.
- Public: anyone can find it in the Store and add it.
A Shared agent needs at least one person, or choose Only me.
Set up the Store page
For a Shared or Public agent:
- Under STORE PAGE, pick a Category (the studio publishes only once you have) and, if it fits, a Second category.
- Under PRICE, choose Free or Paid. For a paid agent, turn on one or more ways to charge: Charge to add it, Take a share of each run or Add a fixed fee per run. See Pricing & earnings.
- On the Store page tab, in Edit mode, fill in how it looks:
- the logo (required for the Store page) and a banner (Add banner). The page's colours come from your logo once you save,
- the Agent name and Short description,
- What's new: what changed in this version,
- About this agent: who it's for, what it needs and what they get, and its tags,
- What it does: a name and a one-line description for each action,
- Works well in a room with: rooms you suggest. See Suggest rooms.
Write the Agent page
On the Agent page tab, in Edit mode, change the wording people see when they run the agent: each action's name, each input's name and the hint people see, what each result is called (What you get back), each receipt's wording, the Run button and the step names.
- Show step names while it runs: when it's on, you name each step in the preview, and your neuron names stay private. When it's off, people see "Working… step 2 of 3".
- Before you publish, each input and receipt has its own choice of what people can do with it. The choices go on the canvas when you publish; Cancel leaves the canvas as it was. Once the agent is published, these are fixed until you unpublish to edit.
- If a neuron now gives a different kind of result than the wording was written for, the studio says so in the top bar and on the result. Click Reset to go back to the default wording.
Examples and preview images
The Store page's Preview shows two screens per action: what it asks for and what it gave back, from its last run in the canvas. Captions are each action's name and description.
- For each action, choose Last run to show its example, or Don't show. No runs yet means the action hasn't run in the canvas.
- Turn on Hide what I typed in to show the result but hide the inputs you used.
- Click Add image to add your own picture to the Preview. With several actions, each action has its own Add image, and the picture goes with that action.
When the agent first goes on the Store, the studio makes images of these screens for the Store (Making the preview images…). Later, if you change the example, the wording or the logo, the Preview says the images changed since they were made. Open the studio and click Refresh preview when you're ready; Make preview makes them if there are none.
Suggest rooms
A room is a group of agents that take turns, each passing its result to the next. Under Works well in a room with, click Suggest a room, then:
- Give it a Room name.
- Add agents with Add an agent…: all your own agents, and agents in the Store. To find a Store agent that isn't listed, type its name in Find a Store agent to add. This agent is always in its rooms. Move an agent earlier to change the turn order.
- Under How to use them together, say how they work as a team.
Each suggested room needs a name and at least one agent besides this one, or publishing stops with a message.
People see these rooms on the agent's Store page and can get every agent in a room in one go.
Secrets
If the workflow has Code neurons that read secrets, the studio has a Secrets box. Choose who provides each one:
- Mine: your value is used for every person's run.
- Mine, users may change: your value is used unless a person adds their own.
- User provides: each person adds their own value before they can run the agent.
Nothing is chosen for you, and publishing waits until every secret has an answer. Not in your Secrets yet means you haven't added that secret on your Secrets page. People never see a secret's value, your code or its logs.
Publish
Check NEEDS THESE ACCOUNTS (the apps people connect; they use their own accounts, and yours are never shared) and the memory line (how many memory items ship with the agent). Then click the button in the studio's top bar:
- Publish for me for Only me,
- Publish and share for Shared,
- Publish to the Store for Public.
If the agent was on the Store before (you unpublished it to edit), the studio also has THIS RELEASE: choose Small fix, New feature or Big change, and say what changed under What's new on the Store page. People see it there.
The workflow becomes read-only. A free agent goes on the Store right away. A paid agent is reviewed first, usually within a day.
Listing status
After you publish, the Publish button in the top bar becomes a listing button that shows the agent's status. The Neurons section shows the same status in a card.
- Published · Only you: in your My agents, with no Store page.
- Shared, with the number of people: on the Store; only the people you added can use it.
- Public on Store: anyone can find and add it.
- Pending review: a paid listing is waiting for review. Change who can use it is greyed out until the review is done.
- Listing rejected: the review turned it down. The card shows the reason. Choose Fix and resubmit, change what's asked, and publish again.
- Finish listing: the listing is missing details. Choose Complete store listing.
- Suspended or Delisted: the agent was taken off the Store. The card shows the reason and the support address to contact about your case. The studio can't be opened from the listing button; you can still Unpublish to edit.
From the listing button, choose View store page to open its Store page, or Open in My agents for an Only me agent.
Change a published agent
Choose Change who can use it from the listing button, or from the card in the Neurons section. The studio opens as Who can use it, and how it looks. Change who can use it, the price or the pages, and click Save changes.
- Choosing Only me for an agent on the Store takes it off the Store.
- Turning a free agent on the Store into a paid one sends it back to review.
A published workflow is read-only on the canvas; you can still run it and edit its memory. To change the workflow itself, open the listing button and choose Unpublish to edit, then Unpublish in Unpublish this agent?. The agent is removed from the Store, people who already have it can still use it from My agents, and the workflow unlocks for editing. Unpublishing also removes the memory that shipped with the agent: people's existing conversations lose the FROM plus your name items. Your next publish ships a new set with the new version. See Publishing and updates.
Manage access to a Shared agent
On your Shared agent's Store page, click Manage access:
- Under Requests, click Approve or Decline for each person who asked. No requests waiting. means there are none.
- Under People who can use it, add someone by email and click Add, or remove a person. Keep at least one person, or choose Only me in the studio.
- Click Change who can use it in the studio to switch to Only me or Public.
When someone asks for access, it also shows on your Home under Needs you; click Review to open Manage access. Your Store page also has Edit listing, which opens the Publish studio.
When an action or event you use is turned off
If an administrator turns off, or sets a date to turn off, an app action or event used by one of your Workflows or published Agents, you get an email, and another if the date is cancelled. Replace the action or event before the date; see App connections. Users are not emailed, but a paused trigger shows them the message.
Write a good description
- Start with what the agent does, in one sentence.
- Describe the inputs it expects and the results it makes.
- List concrete uses.
- Mention anything it needs, such as app connections.
Limits
- Agent name: up to 100 characters.
- Short description: up to 200 characters.
- About this agent: up to 10,000 characters.
- Tags: up to 5 tags.
- Suggested rooms: up to 3 rooms per agent.
- Agents in a suggested room: up to 6 agents.
Common problems
Publish is greyed out
The workflow has no neurons, or a loop. Hover over Publish to see which, then add a neuron or remove the loop.
The studio's publish button is greyed out
Hover over it to see why. For example: a Shared agent has nobody added ("Add at least one person, or choose Only me."), the Store page has no category ("Choose a category for the Store page.") or no logo ("Add a logo for the Store page."), the price is out of range, a new version has no notes ("Say what changed under What's new."), or a secret has no answer.
Publishing stops with a message
The studio checks the workflow when you publish and shows the reason at the top, for example a neuron that needs an output type in MAKE. Fix it on the canvas and publish again.
Published, but the settings weren't saved
"The agent is published for you, but these settings weren't saved (…). Try again to save them." The agent was published, but who can use it, the price or the pages didn't save. Click the studio's button again.
A memory reference blocks publishing
A neuron refers to a memory that won't ship with the agent, so people's copies couldn't read it. In Memory, turn on Ships with the agent for that memory, or remove the reference.
The preview images couldn't be made
The agent is published anyway. Open the studio again and click Refresh preview.
Restore is greyed out in Versions
A published workflow can't be changed, so earlier versions can't be restored. Unpublish first.