Mutations are used to execute operations and manage configs.
input
: WorkflowInputRequest! - Either a workflow configuration or saved workflow IDpayload
: JSON - Input data for the workflow (optional)credentials
: JSON - Runtime credentials for integrations (optional)options
: RequestOptions - Execution options (optional, see RequestOptions defaults)WorkflowResult
with individual step results and final output
instruction
: String! - Natural language description of what the workflow should do (required)payload
: JSON - Sample input data to help with workflow generation (optional)integrationIds
: [ID!]! - List of integration IDs to use in the workflow (required)responseSchema
: JSONSchema - Desired output format (optional, auto-generated if not provided)Workflow
configuration ready for execution
true
if successful.
input
: IntegrationInput! - Integration configuration (required)mode
: UpsertMode - CREATE, UPDATE, or UPSERT (default: UPSERT)true
if successful.
executeWorkflow
and workflow management operations instead.
executeWorkflow
instead for better performance and capabilities.
Executes an API call with the given configuration. Supports both one-time configurations and saved endpoints.
Parameters:
input
: ApiInputRequest! - Either an endpoint configuration or a saved endpoint IDpayload
: JSON - Data to pass to the API (optional)credentials
: JSON - Runtime credentials (optional, overrides stored credentials)options
: RequestOptions - Execution options (optional, see RequestOptions defaults)executeWorkflow
instead for better performance and capabilities.
Extracts data from a file or API response. Handles decompression and parsing of various file formats.
Parameters:
input
: ExtractInputRequest! - Either an extraction configuration, file upload, or saved extraction IDpayload
: JSON - Additional data for the extraction (optional)credentials
: JSON - Runtime credentials for API sources (optional)options
: RequestOptions - Execution options (optional, see RequestOptions defaults)executeWorkflow
instead for better performance and capabilities.
Transforms data using JSONata expressions and validates against a schema.
Parameters:
input
: TransformInputRequest! - Either a transformation configuration or saved transform IDdata
: JSON! - Input data to transform (required)options
: RequestOptions - Execution options (optional, see RequestOptions defaults)true
if successful.
true
if successful.
true
if successful.