Skip to main content

​
List Operations

​
listRuns

Returns a paginated list of execution runs. Parameters:
  • limit: Int - Number of items to return (default: 10, max: 100)
  • offset: Int - Number of items to skip (default: 0)
  • configId: ID - Filter runs by specific configuration ID (optional)
  • GraphQL
  • Client
query ListRuns($limit: Int = 10, $offset: Int = 0, $configId: ID) {
  listRuns(limit: $limit, offset: $offset, configId: $configId) {
    items {
      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
        }
      }
    }
    total
  }
}

​
listWorkflows

Returns a paginated list of workflow configurations.
  • GraphQL
  • Client
query ListWorkflows($limit: Int = 10, $offset: Int = 0) {
  listWorkflows(limit: $limit, offset: $offset) {
    items {
      id
      version
      createdAt
      updatedAt
      instruction
      steps {
        id
        apiConfig {
          id
          urlHost
          urlPath
          method
          instruction
          authentication
        }
        integrationId
        executionMode
        loopSelector
        loopMaxIters
        inputMapping
        responseMapping
      }
      integrationIds
      finalTransform
      responseSchema
      inputSchema
    }
    total
  }
}

​
listIntegrations

Returns a paginated list of integration configurations.
  • GraphQL
  • Client
query ListIntegrations($limit: Int = 10, $offset: Int = 0) {
  listIntegrations(limit: $limit, offset: $offset) {
    items {
      id
      name
      type
      urlHost
      urlPath
      documentationUrl
      documentation
      documentationPending
      specificInstructions
      icon
      version
      createdAt
      updatedAt
    }
    total
  }
}

​
Get Operations

​
getRun

Retrieves a specific execution run by ID.
  • GraphQL
  • Client
query GetRun($id: ID!) {
  getRun(id: $id) {
    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
      }
    }
  }
}

​
getWorkflow

Retrieves a specific workflow configuration by ID.
  • GraphQL
  • Client
query GetWorkflow($id: ID!) {
  getWorkflow(id: $id) {
    id
    version
    createdAt
    updatedAt
    instruction
    steps {
      id
      apiConfig {
        id
        urlHost
        urlPath
        method
        instruction
        authentication
      }
      integrationId
      executionMode
      loopSelector
      loopMaxIters
      inputMapping
      responseMapping
    }
    integrationIds
    finalTransform
    responseSchema
    inputSchema
  }
}

​
getIntegration

Retrieves a specific integration configuration by ID.
  • GraphQL
  • Client
query GetIntegration($id: ID!) {
  getIntegration(id: $id) {
    id
    name
    type
    urlHost
    urlPath
    credentials
    documentationUrl
    documentation
    documentationPending
    specificInstructions
    icon
    version
    createdAt
    updatedAt
  }
}

​
Utility Queries

​
generateSchema

Generates a JSON schema based on instructions and optional response data. Useful for creating response schemas for workflows. Parameters:
  • instruction: String! - Natural language description of the desired schema (required)
  • responseData: String - Sample JSON data to infer schema from (optional)
  • GraphQL
  • Client
query GenerateSchema($instruction: String!, $responseData: String) {
  generateSchema(instruction: $instruction, responseData: $responseData)
}

​
generateInstructions

Generates natural language instructions based on integration configurations. Helps create workflow instructions from available integrations. Parameters:
  • integrations: [IntegrationInput!]! - List of integrations to generate instructions for (required)
  • GraphQL
  • Client
query GenerateInstructions($integrations: [IntegrationInput!]!) {
  generateInstructions(integrations: $integrations)
}

​
getTenantInfo

Retrieves tenant account information.
  • GraphQL
  • Client
query GetTenantInfo {
  getTenantInfo {
    email
    emailEntrySkipped
  }
}

​
findRelevantIntegrations

Finds integrations relevant to a given natural language instruction. Returns suggested integrations with explanations. Parameters:
  • instruction: String - Natural language description of what you want to do (optional, returns all integrations if not provided)
  • GraphQL
  • Client
query FindRelevantIntegrations($instruction: String) {
  findRelevantIntegrations(instruction: $instruction) {
    id
    reason
    savedCredentials
  }
}

​
Fields

  • instruction: String (optional) - Natural language description of what you want to do
  • Returns: Array of SuggestedIntegration objects

​
Deprecated Operations

The following operations are deprecated. Use workflow-based operations instead.

​
listApis (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Returns a paginated list of API configurations.
  • GraphQL
  • Client
query ListApis($limit: Int = 10, $offset: Int = 0) {
  listApis(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      urlPath
      method
      instruction
      authentication
      createdAt
      updatedAt
    }
    total
  }
}

​
listTransforms (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Returns a paginated list of transform configurations.
  • GraphQL
  • Client
query ListTransforms($limit: Int = 10, $offset: Int = 0) {
  listTransforms(limit: $limit, offset: $offset) {
    items {
      id
      instruction
      responseSchema
      responseMapping
      createdAt
      updatedAt
    }
    total
  }
}

​
listExtracts (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Returns a paginated list of extract configurations.
  • GraphQL
  • Client
query ListExtracts($limit: Int = 10, $offset: Int = 0) {
  listExtracts(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      urlPath
      fileType
      decompressionMethod
      instruction
      authentication
      createdAt
      updatedAt
    }
    total
  }
}

​
getApi (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Retrieves a specific API configuration by ID.
  • GraphQL
  • Client
query GetApi($id: ID!) {
  getApi(id: $id) {
    id
    urlHost
    urlPath
    method
    instruction
    headers
    queryParams
    authentication
    responseSchema
    responseMapping
    pagination {
      type
      pageSize
      cursorPath
    }
    dataPath
    createdAt
    updatedAt
  }
}

​
getTransform (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Retrieves a specific transform configuration by ID.
  • GraphQL
  • Client
query GetTransform($id: ID!) {
  getTransform(id: $id) {
    id
    instruction
    responseSchema
    responseMapping
    createdAt
    updatedAt
  }
}

​
getExtract (Deprecated)

⚠️ Deprecated: Use workflow-based operations instead. Retrieves a specific extract configuration by ID.
  • GraphQL
  • Client
query GetExtract($id: ID!) {
  getExtract(id: $id) {
    id
    urlHost
    urlPath
    fileType
    decompressionMethod
    instruction
    authentication
    createdAt
    updatedAt
  }
}
⌘I