Skip to main content
POST
Start Pathway Translation

Overview

Starts a background job that converts pathways into agent scenarios, using Bland’s migration planner for entries in translate mode and the deterministic one-to-one conversion for the rest. The body takes either the pathway-selection shape of Migrate Pathways (stored pathways only) or the persona shape of Migrate Persona; a body containing persona_id is treated as a persona run. The response is 202 with a run record. Poll it with Get Pathway Translation Run and stop it with Cancel Pathway Translation Run. Limited to 10 starts per hour per organization, counted together with Migrate Pathway and Stream Pathway Migration. At most 5 pathways per job may be in translate mode, and at most 3 jobs per organization may be active at once. Requires an admin, owner, operator, or prompter role.

Headers

string
required
Your API key for authentication.

Body Parameters

Send one of the two shapes below. If persona_id is present the persona shape is used and pathways is ignored. Pathway selection
array
required
One to 20 entries, each referencing a stored pathway. Returns 400 INVALID_PATHWAYS for an empty array or a malformed entry, 400 TOO_MANY_PATHWAYS beyond 20, 400 INLINE_PATHWAY_NOT_SUPPORTED if any entry carries an inline pathway graph, and 400 TOO_MANY_TRANSLATIONS if more than 5 entries are in translate mode.
string
Display name for the new agent when create is true. Whitespace is trimmed. Defaults to the pathway’s name when exactly one pathway is given, otherwise Migrated pathways.
boolean
default:"true"
When false, the job produces scenario nodes only (returned in the run’s result.scenarios) instead of creating an agent.
Persona
string
required
UUID of a persona in your organization. Its attached pathways become the job’s items and its prompts and settings become the agent shell, so a persona run always creates an agent. Returns 400 INVALID_PERSONA_ID if not a UUID, 404 PERSONA_NOT_FOUND if no such persona exists in your organization, 422 PERSONA_HAS_NO_VERSION if it has neither a published nor a draft version, 400 NO_PATHWAY_CONDITIONS if it has no attached pathways (use Migrate Persona instead), and 400 TOO_MANY_PATHWAYS if it has more than 20.
string
Display name for the new agent. Defaults to the persona’s name.
array
One entry per attached pathway, in the persona’s order, each one_to_one or translate. The length must match the persona’s pathway count or the request returns 400 INVALID_PATHWAY_MODES. Defaults to translate for every pathway. More than 5 translate entries returns 400 TOO_MANY_TRANSLATIONS.

Response

Returns 202 on success. Returns 429 TOO_MANY_ACTIVE_TRANSLATIONS when 3 jobs are already active for your organization.
object
The new run, always in PENDING status.
null | array
null on success, or a list of error objects if the request failed.

Docs for agents: llms.txt