Nexus
API orchestration and aggregation layer that executes pre-defined orchestration plans.
Operations
POST
# Execute an orchestration plan
FDK Method Name: executeOrchestrationPlan
Executes a pre-defined orchestration plan identified by `planId`. The plan orchestrates one or more downstream API calls according to its configuration (sequential or parallel), applies optional data transforms, and returns aggregated results keyed by each API call step's ID.
The request body is merged with path and query parameters to form the plan's input context. Each plan may define an `input_schema` that enforces required fields.
Parameters
plan_id
string
Required
Unique slug identifier of the orchestration plan to execute.
Request body
brand_id
string
Example field — actual properties vary by plan and are validated at runtime against the plan's `input_schema`.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
404
Plan executed successfully. Returns an object where each key is the step ID of an API call defined in the plan's `api_calls` array.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response