recipes

List the recipes this organization can install: features made of the platform's own collections, tools, flows and automations. Each says what it does, what it will create, what it asks for and which features it needs. One that cannot be installed here says why in unavailable_reason. Install one with install_recipe. Its words are in the language Accept-Language prefers, Spanish or English.

List the recipes installed in this organization, each with its version, parameters, on/off, state, the agent or the connection it is installed for if any, and the parts it made. Give agent_id to list only what is installed for one agent, or channel_id for what answers one connection.

Read one installed recipe: its parameters, whether it is on, its state and every part it made with where that part lives. Reading it also brings it to the recipe's current version when it is behind. A recipe installed per agent is read with agent_id, one installed per connection with channel_id.

Uninstall a recipe: every part it made is deleted -- its placements, tools, flows, automations and collections, the collections' records included -- and the answer names what went. A connection it answered is first left answered by the agent it named, or by a person, as the installed recipe's uninstall_leaves says. It cannot be undone; ask the person first.

Switch an installed recipe on or off: all of its automations, placements and the flow that answers its connection together. Off keeps everything and runs nothing -- a connection it answers leaves each new message waiting for a person -- and on resumes it, a pause included. Refused switching on while the reason it was switched off holds.

Change some of an installed recipe's parameter values; the rest keep theirs. Every part that uses a changed value is rewritten to it. The agent or the connection a recipe is installed for cannot change: for another, install it there.

Bring an installed recipe to its current version now, keeping its parameter values and its records. What the new version no longer has is removed, except collections and fields, which are handed to the organization.

Install a recipe with values for its parameters. It creates the recipe's collections, tools, flows, automations, placements in an agent's slots and the flow that answers a connection, owned by the recipe and switched on, so it starts running. A recipe that asks for an agent is installed once per agent, the one its agent parameter names, and one that asks for a connection once per connection; that agent or connection is fixed once installed. Installing it again -- for the same agent or connection -- changes its parameters and finishes an install that was left incomplete; it never makes a second copy. For a recipe that proposes labels, the first install may give labels: the organization's own labels by id and new ones by name and line, which are created in the organization's vocabulary as its own; those that join fill the recipe's labels parameter. Ask the person first: an installed recipe runs.