Skip to main content

​
Execute Operations

​
executeWorkflow

Executes a workflow (multiple APIs or Endpoints) in a single call. Returns detailed step-by-step results. Parameters:
  • input: WorkflowInputRequest! - Either a workflow configuration or saved workflow ID
  • payload: JSON - Input data for the workflow (optional)
  • credentials: JSON - Runtime credentials for integrations (optional)
  • options: RequestOptions - Execution options (optional, see RequestOptions defaults)
Returns: WorkflowResult with individual step results and final output
  • GraphQL
  • Client
mutation ExecuteWorkflow($input: WorkflowInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  executeWorkflow(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    id
    success
    data
    error
    startedAt
    completedAt
    config {
      id
      version
      instruction
    }
    stepResults {
      stepId
      success
      rawData
      transformedData
      error
    }
  }
}

​
buildWorkflow

Builds a workflow automatically based on instructions and available integrations. Uses AI to determine the optimal sequence of API calls and data transformations. Supports both API-based workflows and transform-only workflows for data processing. Parameters:
  • instruction: String! - Natural language description of what the workflow should do (required)
  • payload: JSON - Sample input data to help with workflow generation (optional, supports file upload data)
  • integrationIds: [ID!] - List of integration IDs to use in the workflow (optional - omit for transform-only workflows)
  • responseSchema: JSONSchema - Desired output format (optional, auto-generated if not provided)
Returns: Complete Workflow configuration ready for execution
  • GraphQL
  • Client
mutation BuildWorkflow(
  $instruction: String!,
  $payload: JSON,
  $integrationIds: [ID!],
  $responseSchema: JSONSchema
) {
  buildWorkflow(
    instruction: $instruction,
    payload: $payload,
    integrationIds: $integrationIds,
    responseSchema: $responseSchema
  ) {
    id
    version
    instruction
    steps {
      id
      apiConfig {
        id
        urlHost
        urlPath
        method
        instruction
      }
      integrationId
      executionMode
      inputMapping
      responseMapping
    }
    finalTransform
    responseSchema
    inputSchema
  }
}

​
Configuration Management

​
upsertWorkflow

Creates or updates a workflow configuration.
  • GraphQL
  • Client
mutation UpsertWorkflow($id: ID!, $input: JSON!) {
  upsertWorkflow(id: $id, input: $input) {
    id
    version
    instruction
    steps {
      id
      apiConfig {
        id
        urlHost
        urlPath
        method
        instruction
      }
      integrationId
      executionMode
      inputMapping
      responseMapping
    }
    finalTransform
    responseSchema
    inputSchema
  }
}

​
deleteWorkflow

Deletes a workflow configuration. Returns true if successful.
  • GraphQL
  • Client
mutation DeleteWorkflow($id: ID!) {
  deleteWorkflow(id: $id)
}

​
upsertIntegration

Creates or updates an integration configuration. Integrations represent connections to external APIs or databases. Parameters:
  • input: IntegrationInput! - Integration configuration (required)
  • mode: UpsertMode - CREATE, UPDATE, or UPSERT (default: UPSERT)
  • GraphQL
  • Client
mutation UpsertIntegration($input: IntegrationInput!, $mode: UpsertMode = UPSERT) {
  upsertIntegration(input: $input, mode: $mode) {
    id
    name
    type
    urlHost
    urlPath
    credentials
    documentationUrl
    documentation
    documentationPending
    specificInstructions
    icon
    version
    createdAt
    updatedAt
  }
}

​
deleteIntegration

Deletes an integration configuration. Returns true if successful.
  • GraphQL
  • Client
mutation DeleteIntegration($id: ID!) {
  deleteIntegration(id: $id)
}

​
Deprecated Operations

The following operations are deprecated. Use executeWorkflow and workflow management operations instead.

​
call (Deprecated)

⚠️ Deprecated: Use 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 ID
  • payload: JSON - Data to pass to the API (optional)
  • credentials: JSON - Runtime credentials (optional, overrides stored credentials)
  • options: RequestOptions - Execution options (optional, see RequestOptions defaults)
  • GraphQL
  • Client
mutation Call($input: ApiInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  call(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on ApiConfig {
        id
        urlHost
        urlPath
        method
        instruction
        authentication
        createdAt
        updatedAt
      }
      ... on ExtractConfig {
        id
        urlHost
        urlPath
        fileType
        decompressionMethod
        instruction
        authentication
        createdAt
        updatedAt
      }
      ... on TransformConfig {
        id
        instruction
        responseSchema
        responseMapping
        createdAt
        updatedAt
      }
      ... on Workflow {
        id
        version
        instruction
        createdAt
        updatedAt
      }
    }
  }
}

​
extract (Deprecated)

⚠️ Deprecated: Use 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 ID
  • payload: JSON - Additional data for the extraction (optional)
  • credentials: JSON - Runtime credentials for API sources (optional)
  • options: RequestOptions - Execution options (optional, see RequestOptions defaults)
  • GraphQL
  • Client
mutation Extract($input: ExtractInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  extract(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on ExtractConfig {
        id
        urlHost
        urlPath
        fileType
        decompressionMethod
        instruction
        authentication
        createdAt
        updatedAt
      }
    }
  }
}

​
transform (Deprecated)

⚠️ Deprecated: Use 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 ID
  • data: JSON! - Input data to transform (required)
  • options: RequestOptions - Execution options (optional, see RequestOptions defaults)
  • GraphQL
  • Client
mutation Transform($input: TransformInputRequest!, $data: JSON!, $options: RequestOptions) {
  transform(input: $input, data: $data, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on TransformConfig {
        id
        instruction
        responseSchema
        responseMapping
        createdAt
        updatedAt
      }
    }
  }
}

​
upsertApi (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Creates or updates an API configuration.
  • GraphQL
  • Client
mutation UpsertApi($id: ID!, $input: JSON!) {
  upsertApi(id: $id, input: $input) {
    id
    urlHost
    urlPath
    method
    instruction
    headers
    queryParams
    body
    authentication
    responseSchema
    responseMapping
    pagination {
      type
      pageSize
      cursorPath
    }
    dataPath
    updatedAt
  }
}

​
updateApiConfigId (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Updates the ID of an existing API configuration.
  • GraphQL
  • Client
mutation UpdateApiConfigId($oldId: ID!, $newId: ID!) {
  updateApiConfigId(oldId: $oldId, newId: $newId) {
    id
    urlHost
    urlPath
    method
    instruction
  }
}

​
deleteApi (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Deletes an API configuration. Returns true if successful.
  • GraphQL
  • Client
mutation DeleteApi($id: ID!) {
  deleteApi(id: $id)
}

​
upsertExtraction (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Creates or updates an extraction configuration.
  • GraphQL
  • Client
mutation UpsertExtraction($id: ID!, $input: JSON!) {
  upsertExtraction(id: $id, input: $input) {
    id
    urlHost
    urlPath
    instruction
    fileType
    decompressionMethod
  }
}

​
deleteExtraction (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Deletes an extraction configuration. Returns true if successful.
  • GraphQL
  • Client
mutation DeleteExtraction($id: ID!) {
  deleteExtraction(id: $id)
}

​
upsertTransformation (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Creates or updates a transformation configuration.
  • GraphQL
  • Client
mutation UpsertTransformation($id: ID!, $input: JSON!) {
  upsertTransformation(id: $id, input: $input) {
    id
    instruction
    responseSchema
    responseMapping
  }
}

​
deleteTransformation (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Deletes a transformation configuration. Returns true if successful.
  • GraphQL
  • Client
mutation DeleteTransformation($id: ID!) {
  deleteTransformation(id: $id)
}
See also:
⌘I