​
Types Reference

​
Base Types

interface BaseConfig {
  id: ID!
  version: String
  createdAt: DateTime
  updatedAt: DateTime
}

union ConfigType = ApiConfig | ExtractConfig | TransformConfig

​
ApiConfig

Configuration for API endpoints. Inherits from BaseConfig.

type ApiConfig implements BaseConfig {
  id: ID!
  version: String
  createdAt: DateTime
  updatedAt: DateTime
  
  urlHost: String!                  # Base URL for the API
  urlPath: String                   # Path component of the URL
  method: HttpMethod!               # HTTP method to use
  headers: JSON                     # Request headers
  queryParams: JSON                 # URL query parameters
  body: String                      # Request body
  instruction: String!              # Natural language description of the transformation
  authentication: AuthType          # Authentication method
  responseSchema: JSONSchema        # Expected response format
  responseMapping: JSONata         # JSONata transformation expression
  pagination: Pagination           # Pagination configuration
  dataPath: String                 # Path to data in response
  documentationUrl: String
}

​
ExtractConfig

Configuration for data extraction. Inherits from BaseConfig.

type ExtractConfig implements BaseConfig {
  id: ID!
  version: String
  createdAt: DateTime
  updatedAt: DateTime
  
  urlHost: String!                  # Source URL or file location
  urlPath: String                   # Path component of the URL
  method: HttpMethod!               # HTTP method for API sources
  headers: JSON                     # Request headers
  queryParams: JSON                 # URL query parameters
  body: String                      # Request body
  instruction: String!              # Natural language description
  authentication: AuthType          # Authentication method
  fileType: FileType                # Format of the source file
  decompressionMethod: DecompressionMethod  # Decompression algorithm
  dataPath: String                  # Path to data in file/response
  documentationUrl: String
}

​
TransformConfig

Configuration for data transformation. Inherits from BaseConfig.

type TransformConfig implements BaseConfig {
  id: ID!
  version: String
  createdAt: DateTime
  updatedAt: DateTime
  
  instruction: String!              # Natural language description
  responseSchema: JSONSchema!       # Target data format
  responseMapping: JSONata!        # Transformation expression
  confidence: Float                # Confidence score of the mapping
  confidence_reasoning: String     # Explanation of confidence score
}

​
Workflow

type Workflow implements BaseConfig {
  id: ID!
  version: String
  createdAt: DateTime
  updatedAt: DateTime
  steps: [ExecutionStep!]!
  finalTransform: JSONata
  responseSchema: JSONSchema
}

​
ExecutionStep

type ExecutionStep {
  id: String!
  apiConfig: ApiConfig!
  executionMode: String # DIRECT | LOOP
  loopSelector: JSONata
  loopMaxIters: Int
  inputMapping: JSONata
  responseMapping: JSONata
}

​
WorkflowResult

type WorkflowResult {
  success: Boolean!
  data: JSON!
  finalTransform: JSONata
  stepResults: [WorkflowStepResult!]!
  error: String
  startedAt: DateTime!
  completedAt: DateTime!
}

​
WorkflowStepResult

type WorkflowStepResult {
  stepId: String!
  success: Boolean!
  rawData: JSON
  transformedData: JSON
  error: String
}

​
SystemInput

input SystemInput {
  id: String!
  urlHost: String!
  urlPath: String
  documentationUrl: String
  documentation: String
  credentials: JSON
}

​
Pagination

type Pagination {
  type: PaginationType!
  pageSize: String
  cursorPath: String
}

​
Enums

​
HttpMethod

Available HTTP methods:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • HEAD
  • OPTIONS

​
AuthType

Authentication methods:

  • NONE - No authentication
  • HEADER - Authentication via headers
  • QUERY_PARAM - Authentication via query parameters
  • OAUTH2 - OAuth 2.0 authentication

​
FileType

Supported file formats:

  • AUTO - Automatic detection
  • JSON - JSON files
  • CSV - CSV files
  • XML - XML files

​
DecompressionMethod

Available decompression methods:

  • NONE - No decompression
  • GZIP - gzip compression
  • DEFLATE - deflate compression
  • ZIP - zip archives
  • AUTO - Automatic detection

​
CacheMode

Cache behavior options:

  • ENABLED - Full caching
  • DISABLED - No caching
  • READONLY - Read-only cache
  • WRITEONLY - Write-only cache

​
PaginationType

Pagination type options:

  • OFFSET_BASED - Offset-based pagination
  • PAGE_BASED - Page-based pagination
  • CURSOR_BASED - Cursor-based pagination
  • DISABLED - Disabled pagination

​
LogLevel

Log level options:

  • DEBUG - Debug level
  • INFO - Info level
  • WARN - Warn level
  • ERROR - Error level

​
Subscriptions

​
logs

Stream log messages in real time.

subscription {
  logs {
    id
    message
    level
    timestamp
    runId
  }
}
  • id: ID of the log message
  • message: Log message string
  • level: LogLevel (DEBUG, INFO, WARN, ERROR)
  • timestamp: DateTime
  • runId: ID of the related run (optional)

See also: