API Reference
Queries
API Reference
Queries
Queries are used to retrieve configs, logs, and workflow info.
List Operations
listRuns
Returns a paginated list of execution runs.
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
}
}
}
total
}
}
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
}
}
}
total
}
}
const { items, total } = await client.listRuns(100, 0);
listApis
Returns a paginated list of API configurations.
query ListApis($limit: Int = 10, $offset: Int = 0) {
listApis(limit: $limit, offset: $offset) {
items {
id
urlHost
urlPath
method
instruction
authentication
createdAt
updatedAt
}
total
}
}
query ListApis($limit: Int = 10, $offset: Int = 0) {
listApis(limit: $limit, offset: $offset) {
items {
id
urlHost
urlPath
method
instruction
authentication
createdAt
updatedAt
}
total
}
}
const { items, total } = await client.listApis(10, 0);
listTransforms
Returns a paginated list of transform configurations.
query ListTransforms($limit: Int = 10, $offset: Int = 0) {
listTransforms(limit: $limit, offset: $offset) {
items {
id
instruction
responseSchema
responseMapping
createdAt
updatedAt
}
total
}
}
query ListTransforms($limit: Int = 10, $offset: Int = 0) {
listTransforms(limit: $limit, offset: $offset) {
items {
id
instruction
responseSchema
responseMapping
createdAt
updatedAt
}
total
}
}
const { items, total } = await client.listTransforms(10, 0);
listExtracts
Returns a paginated list of extract configurations.
query ListExtracts($limit: Int = 10, $offset: Int = 0) {
listExtracts(limit: $limit, offset: $offset) {
items {
id
urlHost
urlPath
fileType
decompressionMethod
instruction
authentication
createdAt
updatedAt
}
total
}
}
query ListExtracts($limit: Int = 10, $offset: Int = 0) {
listExtracts(limit: $limit, offset: $offset) {
items {
id
urlHost
urlPath
fileType
decompressionMethod
instruction
authentication
createdAt
updatedAt
}
total
}
}
const { items, total } = await client.listExtracts(10, 0);
listWorkflows
Returns a paginated list of workflow configurations.
query ListWorkflows($limit: Int = 10, $offset: Int = 0) {
listWorkflows(limit: $limit, offset: $offset) {
id
version
createdAt
updatedAt
steps {
id
apiConfig {
id
urlHost
urlPath
method
instruction
authentication
}
executionMode
loopSelector
loopMaxIters
inputMapping
responseMapping
}
finalTransform
responseSchema
}
}
query ListWorkflows($limit: Int = 10, $offset: Int = 0) {
listWorkflows(limit: $limit, offset: $offset) {
id
version
createdAt
updatedAt
steps {
id
apiConfig {
id
urlHost
urlPath
method
instruction
authentication
}
executionMode
loopSelector
loopMaxIters
inputMapping
responseMapping
}
finalTransform
responseSchema
}
}
const workflows = await client.listWorkflows(10, 0);
Get Operations
getRun
Retrieves a specific execution run by ID.
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
}
}
}
}
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
}
}
}
}
const run = await client.getRun("run-id");
getApi
Retrieves a specific API configuration by ID.
query GetApi($id: ID!) {
getApi(id: $id) {
id
urlHost
urlPath
method
instruction
headers
queryParams
authentication
responseSchema
responseMapping
pagination {
type
pageSize
cursorPath
}
dataPath
createdAt
updatedAt
}
}
query GetApi($id: ID!) {
getApi(id: $id) {
id
urlHost
urlPath
method
instruction
headers
queryParams
authentication
responseSchema
responseMapping
pagination {
type
pageSize
cursorPath
}
dataPath
createdAt
updatedAt
}
}
const config = await client.getApi("api-config-id");
getTransform
Retrieves a specific transform configuration by ID.
query GetTransform($id: ID!) {
getTransform(id: $id) {
id
instruction
responseSchema
responseMapping
createdAt
updatedAt
}
}
query GetTransform($id: ID!) {
getTransform(id: $id) {
id
instruction
responseSchema
responseMapping
createdAt
updatedAt
}
}
const config = await client.getTransform("transform-config-id");
getExtract
Retrieves a specific extract configuration by ID.
query GetExtract($id: ID!) {
getExtract(id: $id) {
id
urlHost
urlPath
fileType
decompressionMethod
instruction
authentication
createdAt
updatedAt
}
}
query GetExtract($id: ID!) {
getExtract(id: $id) {
id
urlHost
urlPath
fileType
decompressionMethod
instruction
authentication
createdAt
updatedAt
}
}
const config = await client.getExtract("extract-config-id");
getWorkflow
Retrieves a specific workflow configuration by ID.
query GetWorkflow($id: ID!) {
getWorkflow(id: $id) {
id
version
createdAt
updatedAt
steps {
id
apiConfig {
id
urlHost
urlPath
method
instruction
authentication
}
executionMode
loopSelector
loopMaxIters
inputMapping
responseMapping
}
finalTransform
responseSchema
}
}
query GetWorkflow($id: ID!) {
getWorkflow(id: $id) {
id
version
createdAt
updatedAt
steps {
id
apiConfig {
id
urlHost
urlPath
method
instruction
authentication
}
executionMode
loopSelector
loopMaxIters
inputMapping
responseMapping
}
finalTransform
responseSchema
}
}
const workflow = await client.getWorkflow("workflow-id");
generateSchema
Generates a JSON schema based on instructions and optional response data.
query GenerateSchema($instruction: String!, $responseData: String) {
generateSchema(instruction: $instruction, responseData: $responseData)
}
query GenerateSchema($instruction: String!, $responseData: String) {
generateSchema(instruction: $instruction, responseData: $responseData)
}
const schema = await client.generateSchema(
"Get me all characters with only their name",
'[{"name": "Rick", "species": "Human"}, {"name": "Morty", "species": "Human"}]'
);