Yandex Workflow Language

YaWL specification file

Type Workflow
File match *.yawl.yaml *.yawl.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/yandex-workflow-language/latest.json
Source https://raw.githubusercontent.com/yandex-cloud/json-schema-store/master/serverless/workflows/yawl.json

Validate with Lintel

npx @lintel/lintel check
Type: Workflow

Definitions

Workflow object
yawl string required
pattern=^0.1$
start string required
steps Record<string, object> required
defaultRetryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
yawl.AIAgent object
agentConfig object required
6 nested properties
goal string required
role string required
backstory string
model object
All of: variant
2 nested properties
name string
uri string
knowledgeSources yawl.KnowledgeSource[]
tools yawl.AIAgentTool[]
tasks yawl.AIAgentTask[] required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
catch yawl.CatchRule[]
yawl.AIAgentConfig object
goal string required
role string required
backstory string
model object
All of: variant
2 nested properties
name string
uri string
knowledgeSources yawl.KnowledgeSource[]
tools yawl.AIAgentTool[]
yawl.AIAgentModel object
name string
uri string
yawl.AIAgentTask object
description string required
result string
yawl.AIAgentTool object
mcpServer object
All of: variant
4 nested properties
endpoint string required
transport string required
Values: "UNSPECIFIED" "SSE" "STREAMABLE"
token string
useServiceAccount boolean
yawl.AIStudioAgent object
promptTemplateId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
variables Record<string, string>
message string
catch yawl.CatchRule[]
yawl.Branch object
start string required
steps Record<string, object> required
yawl.CatchRule object
errorList enum[] required
output string required
next string required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
yawl.Choice object
condition string required
next string required
yawl.ContainerCall object
containerId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
path string
method string
Values: "OPTIONS" "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "TRACE" "CONNECT"
body string
headers Record<string, string>
query Record<string, string>
catch yawl.CatchRule[]
yawl.DatabaseConnection object
type string required
Values: "UNSPECIFIED" "MYSQL" "POSTGRES" "YDB" "CLICKHOUSE"
host string required
port integer required
database string required
ssl boolean
simple object
2 nested properties
username string required
password string required
iam boolean
yawl.DatabaseConnectionSimpleAuth object
username string required
password string required
yawl.DatabaseQuery object
query string required
mode string required
Values: "UNSPECIFIED" "EXEC" "QUERY"
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
connection object
All of: variant
7 nested properties
type string required
Values: "UNSPECIFIED" "MYSQL" "POSTGRES" "YDB" "CLICKHOUSE"
host string required
port integer required
database string required
ssl boolean
simple object
2 nested properties
username string required
password string required
iam boolean
dsn string
catch yawl.CatchRule[]
yawl.Default object
next string required
yawl.Disk object
oauthToken string required
path string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
sharedDiskId string
upload object
2 nested properties
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
download object
1 nested properties
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
catch yawl.CatchRule[]
yawl.DiskDownload object
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
yawl.DiskUpload object
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
yawl.Fail object
errorMessage string required
yawl.FileKnowledgeSource object
dataSource object required
All of: variant
2 nested properties
urlSource object
1 nested properties
url string required
objectStorageSource object
2 nested properties
bucket string required
object string required
type string required
Values: "UNSPECIFIED" "TEXT" "JSON" "CSV" "PDF" "EXCEL"
yawl.FileKnowledgeSource.DataSource object
urlSource object
1 nested properties
url string required
objectStorageSource object
2 nested properties
bucket string required
object string required
yawl.FileKnowledgeSource.ObjectStorageDataSource object
bucket string required
object string required
yawl.FileKnowledgeSource.UrlDataSource object
url string required
yawl.Foreach object
input string required
output string required
do object required
2 nested properties
start string required
steps Record<string, object> required
next string
concurrency integer
yawl.ForeachDo object
start string required
steps Record<string, object> required
yawl.FoundationModelsCall object
modelUrl string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
generate object
All of: variant, variant
7 nested properties
temperature number required
maxTokens integer required
json string
messages object
1 nested properties
messages yawl.FoundationModelsGenerate.Message[] required
minItems=1
reasoningOptions object
1 nested properties
mode string required
Values: "REASONING_MODE_UNSPECIFIED" "DISABLED" "ENABLED_HIDDEN"
jsonSchema string
jsonObject boolean
classify object
1 nested properties
text string required
fewShotClassify object
All of: variant, variant
6 nested properties
taskDescription string required
text string required
labelsJson string
labelsArray object
1 nested properties
labels string[] required
minItems=1
samplesJson string
samplesArray object
1 nested properties
samples yawl.FoundationModelsFewShotClassify.Sample[] required
minItems=1
catch yawl.CatchRule[]
yawl.FoundationModelsClassify object
text string required
yawl.FoundationModelsFewShotClassify object
taskDescription string required
text string required
labelsJson string
labelsArray object
1 nested properties
labels string[] required
minItems=1
samplesJson string
samplesArray object
1 nested properties
samples yawl.FoundationModelsFewShotClassify.Sample[] required
minItems=1
yawl.FoundationModelsFewShotClassify.Labels object
labels string[] required
minItems=1
yawl.FoundationModelsFewShotClassify.Sample object
text string required
label string required
yawl.FoundationModelsFewShotClassify.Samples object
samples yawl.FoundationModelsFewShotClassify.Sample[] required
minItems=1
yawl.FoundationModelsGenerate object
temperature number required
maxTokens integer required
json string
messages object
1 nested properties
messages yawl.FoundationModelsGenerate.Message[] required
minItems=1
reasoningOptions object
1 nested properties
mode string required
Values: "REASONING_MODE_UNSPECIFIED" "DISABLED" "ENABLED_HIDDEN"
jsonSchema string
jsonObject boolean
yawl.FoundationModelsGenerate.Message object
role string required
text string required
yawl.FoundationModelsGenerate.Messages object
messages yawl.FoundationModelsGenerate.Message[] required
minItems=1
yawl.FoundationModelsGenerate.ReasoningOptions object
mode string required
Values: "REASONING_MODE_UNSPECIFIED" "DISABLED" "ENABLED_HIDDEN"
yawl.FunctionCall object
functionId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
tag string
catch yawl.CatchRule[]
yawl.GRPCCall object
endpoint string required
method string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
useServiceAccount boolean
body string
headers Record<string, string>
catch yawl.CatchRule[]
yawl.HTTPCall object
url string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
method string
Values: "OPTIONS" "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "TRACE" "CONNECT"
body string
headers Record<string, string>
query Record<string, string>
useServiceAccount boolean
catch yawl.CatchRule[]
yawl.InterpolatableMap object
json string
plainValue object
1 nested properties
pairs Record<string, string>
yawl.KnowledgeSource object
textSource object
1 nested properties
content string required
fileSource object
2 nested properties
dataSource object required
All of: variant
2 nested properties
urlSource object
objectStorageSource object
type string required
Values: "UNSPECIFIED" "TEXT" "JSON" "CSV" "PDF" "EXCEL"
yawl.MCPServer object
endpoint string required
transport string required
Values: "UNSPECIFIED" "SSE" "STREAMABLE"
token string
useServiceAccount boolean
yawl.MapValue object
pairs Record<string, string>
yawl.NoOp object
output string required
next string required
yawl.ObjectStorage object
bucket string required
object string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
2 nested properties
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
get object
1 nested properties
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
catch yawl.CatchRule[]
yawl.ObjectStorageGet object
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
yawl.ObjectStoragePut object
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
yawl.Organization object
yandexOrganizationId string
cloudOrganizationId string
yawl.Parallel object
branches Record<string, object> required
input string
output string
next string
concurrency integer
yawl.Postbox object
fromAddress string required
destination object required
2 nested properties
toAddresses string required
ccAddresses string
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
simple object
2 nested properties
subject object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
body object required
2 nested properties
text object required
html object required
raw object
1 nested properties
data string required
catch yawl.CatchRule[]
yawl.PostboxBody object
text object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
html object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
yawl.PostboxDestination object
toAddresses string required
ccAddresses string
yawl.PostboxMessageData object
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
yawl.PostboxRawMessage object
data string required
yawl.PostboxSimpleMessage object
subject object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
body object required
2 nested properties
text object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
html object required
2 nested properties
data string required
charset string required
Values: "CHARSET_UNSPECIFIED" "UTF_8" "ISO_8859_1" "SHIFT_JIS"
yawl.RetryPolicy object
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
yawl.StartWorkflow object
workflowId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
executionInput string
catch yawl.CatchRule[]
yawl.Step object
title string
description string
switch object
3 nested properties
choices yawl.Choice[] required
input string
default object
1 nested properties
next string required
foreach object
5 nested properties
input string required
output string required
do object required
2 nested properties
start string required
steps Record<string, object> required
next string
concurrency integer
parallel object
5 nested properties
branches Record<string, object> required
input string
output string
next string
concurrency integer
success object
fail object
1 nested properties
errorMessage string required
noOp object
2 nested properties
output string required
next string required
functionCall object
8 nested properties
functionId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
tag string
catch yawl.CatchRule[]
containerCall object
12 nested properties
containerId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
path string
method string
Values: "OPTIONS" "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "TRACE" "CONNECT"
body string
headers Record<string, string>
query Record<string, string>
catch yawl.CatchRule[]
httpCall object
12 nested properties
url string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
method string
Values: "OPTIONS" "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "TRACE" "CONNECT"
body string
headers Record<string, string>
query Record<string, string>
useServiceAccount boolean
catch yawl.CatchRule[]
grpcCall object
11 nested properties
endpoint string required
method string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
useServiceAccount boolean
body string
headers Record<string, string>
catch yawl.CatchRule[]
ydbDocument object
All of: variant
12 nested properties
database string required
tableName string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
get object
1 nested properties
key string required
put object
1 nested properties
item string required
update object
3 nested properties
key string required
expression string required
expressionAttributeValues string
scan object
2 nested properties
limit string required
exclusiveStartKey string required
catch yawl.CatchRule[]
yds object
All of: variant
9 nested properties
database string required
topic string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
2 nested properties
body string
partitionKey string
catch yawl.CatchRule[]
ymq object
All of: variant
8 nested properties
queueArn string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
1 nested properties
body string
catch yawl.CatchRule[]
foundationModelsCall object
All of: variant
10 nested properties
modelUrl string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
generate object
All of: variant, variant
7 nested properties
temperature number required
maxTokens integer required
json string
messages object
reasoningOptions object
jsonSchema string
jsonObject boolean
classify object
1 nested properties
text string required
fewShotClassify object
All of: variant, variant
6 nested properties
taskDescription string required
text string required
labelsJson string
labelsArray object
samplesJson string
samplesArray object
catch yawl.CatchRule[]
objectStorage object
All of: variant
10 nested properties
bucket string required
object string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
2 nested properties
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
get object
1 nested properties
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
catch yawl.CatchRule[]
tracker object
All of: variant
18 nested properties
oauthToken string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
endpoint string
organization object
All of: variant
2 nested properties
yandexOrganizationId string
cloudOrganizationId string
getIssue object
1 nested properties
key string required
createIssue object
11 nested properties
queue string required
title string required
parent string
description string
sprints string
type string
priority string
followers string
assignee string
author string
additionalProperties Record<string, string>
updateIssue object
9 nested properties
key string required
title string
parent string
description string
sprints object
All of: variant
type string
priority string
followers object
All of: variant
additionalProperties object
listIssues object
All of: variant
6 nested properties
pageSize string
pageNumber string
queue string
keys string
filter object
query string
linkIssues object
3 nested properties
key string required
linkKey string required
relationship string required
updateIssueStatus object
3 nested properties
key string required
transition string required
additionalProperties object
createComment object
3 nested properties
key string required
text string required
mentions string
updateComment object
3 nested properties
id string required
issueKey string required
text string required
listComments object
3 nested properties
key string required
lastCommentId string
pageSize string
catch yawl.CatchRule[]
postbox object
All of: variant
10 nested properties
fromAddress string required
destination object required
2 nested properties
toAddresses string required
ccAddresses string
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
simple object
2 nested properties
subject object required
body object required
raw object
1 nested properties
data string required
catch yawl.CatchRule[]
wait object
All of: variant
3 nested properties
next string
duration string
until string
disk object
All of: variant
11 nested properties
oauthToken string required
path string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
sharedDiskId string
upload object
2 nested properties
content string required
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
download object
1 nested properties
contentType string

Used for Object Storage and Yandex Disk downloads

Values: "BINARY" "JSON" "TEXT" "EXCEL" "CSV"
catch yawl.CatchRule[]
workflow object
8 nested properties
workflowId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
executionInput string
catch yawl.CatchRule[]
while object
6 nested properties
do object required
2 nested properties
start string required
steps Record<string, object> required
input string
output string
condition string
maxIterations integer
next string
aiAgent object
8 nested properties
agentConfig object required
6 nested properties
goal string required
role string required
backstory string
model object
All of: variant
knowledgeSources yawl.KnowledgeSource[]
tools yawl.AIAgentTool[]
tasks yawl.AIAgentTask[] required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
catch yawl.CatchRule[]
telegramBot object
All of: variant
8 nested properties
token string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
sendMessage object
4 nested properties
chatId string required
text string required
parseMode string
Values: "UNSPECIFIED" "MARKDOWN" "MARKDOWNV2" "HTML"
replyTo string
catch yawl.CatchRule[]
databaseQuery object
All of: variant
10 nested properties
query string required
mode string required
Values: "UNSPECIFIED" "EXEC" "QUERY"
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
connection object
All of: variant
7 nested properties
type string required
Values: "UNSPECIFIED" "MYSQL" "POSTGRES" "YDB" "CLICKHOUSE"
host string required
port integer required
database string required
ssl boolean
simple object
iam boolean
dsn string
catch yawl.CatchRule[]
aiStudioAgent object
9 nested properties
promptTemplateId string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
variables Record<string, string>
message string
catch yawl.CatchRule[]
vectorStore object
All of: variant
7 nested properties
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
uploadFile object
All of: variant
5 nested properties
vectorStoreId string required
textFile object
urlFile object
objectStorage object
attributes Record<string, string>
catch yawl.CatchRule[]
yawl.Success object
yawl.Switch object
choices yawl.Choice[] required
input string
default object
1 nested properties
next string required
yawl.TelegramBot object
token string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
sendMessage object
4 nested properties
chatId string required
text string required
parseMode string
Values: "UNSPECIFIED" "MARKDOWN" "MARKDOWNV2" "HTML"
replyTo string
catch yawl.CatchRule[]
yawl.TelegramBotSendMessage object
chatId string required
text string required
parseMode string
Values: "UNSPECIFIED" "MARKDOWN" "MARKDOWNV2" "HTML"
replyTo string
yawl.TextKnowledgeSource object
content string required
yawl.Tracker object
oauthToken string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
endpoint string
organization object
All of: variant
2 nested properties
yandexOrganizationId string
cloudOrganizationId string
getIssue object
1 nested properties
key string required
createIssue object
11 nested properties
queue string required
title string required
parent string
description string
sprints string
type string
priority string
followers string
assignee string
author string
additionalProperties Record<string, string>
updateIssue object
9 nested properties
key string required
title string
parent string
description string
sprints object
All of: variant
4 nested properties
setValue string
addValuesList string
removeValuesList string
replaceValuesMap object
All of: variant
type string
priority string
followers object
All of: variant
4 nested properties
setValue string
addValuesList string
removeValuesList string
replaceValuesMap object
All of: variant
additionalProperties object
1 nested properties
pairs Record<string, object>
listIssues object
All of: variant
6 nested properties
pageSize string
pageNumber string
queue string
keys string
filter object
2 nested properties
issueProperties Record<string, string>
order string
query string
linkIssues object
3 nested properties
key string required
linkKey string required
relationship string required
updateIssueStatus object
3 nested properties
key string required
transition string required
additionalProperties object
1 nested properties
pairs Record<string, string>
createComment object
3 nested properties
key string required
text string required
mentions string
updateComment object
3 nested properties
id string required
issueKey string required
text string required
listComments object
3 nested properties
key string required
lastCommentId string
pageSize string
catch yawl.CatchRule[]
yawl.TrackerCreateComment object
key string required
text string required
mentions string
yawl.TrackerCreateIssue object
queue string required
title string required
parent string
description string
sprints string
type string
priority string
followers string
assignee string
author string
additionalProperties Record<string, string>
yawl.TrackerGetIssue object
key string required
yawl.TrackerLinkIssues object
key string required
linkKey string required
relationship string required
yawl.TrackerListComments object
key string required
lastCommentId string
pageSize string
yawl.TrackerListIssues object
pageSize string
pageNumber string
queue string
keys string
filter object
2 nested properties
issueProperties Record<string, string>
order string
query string
yawl.TrackerListIssues.SearchOptionsFilter object
issueProperties Record<string, string>
order string
yawl.TrackerUpdateComment object
id string required
issueKey string required
text string required
yawl.TrackerUpdateIssue object
key string required
title string
parent string
description string
sprints object
All of: variant
4 nested properties
setValue string
addValuesList string
removeValuesList string
replaceValuesMap object
All of: variant
2 nested properties
json string
plainValue object
type string
priority string
followers object
All of: variant
4 nested properties
setValue string
addValuesList string
removeValuesList string
replaceValuesMap object
All of: variant
2 nested properties
json string
plainValue object
additionalProperties object
1 nested properties
pairs Record<string, object>
yawl.TrackerUpdateIssue.Action object
setValue string
addValuesList string
removeValuesList string
replaceValuesMap object
All of: variant
2 nested properties
json string
plainValue object
1 nested properties
pairs Record<string, string>
yawl.TrackerUpdateIssue.AdditionalProperties object
pairs Record<string, object>
yawl.TrackerUpdateIssueStatus object
key string required
transition string required
additionalProperties object
1 nested properties
pairs Record<string, string>
yawl.VectorStore object
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
uploadFile object
All of: variant
5 nested properties
vectorStoreId string required
textFile object
2 nested properties
text string required
fileName string required
urlFile object
2 nested properties
url string required
fileName string required
objectStorage object
2 nested properties
bucket string required
object string required
attributes Record<string, string>
catch yawl.CatchRule[]
yawl.VectorStore.UploadFile object
vectorStoreId string required
textFile object
2 nested properties
text string required
fileName string required
urlFile object
2 nested properties
url string required
fileName string required
objectStorage object
2 nested properties
bucket string required
object string required
attributes Record<string, string>
yawl.VectorStore.UploadFile.ObjectStorage object
bucket string required
object string required
yawl.VectorStore.UploadFile.TextFile object
text string required
fileName string required
yawl.VectorStore.UploadFile.UrlFile object
url string required
fileName string required
yawl.Wait object
next string
duration string
until string
yawl.While object
do object required
2 nested properties
start string required
steps Record<string, object> required
input string
output string
condition string
maxIterations integer
next string
yawl.WhileDo object
start string required
steps Record<string, object> required
yawl.YDBDocument object
database string required
tableName string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
get object
1 nested properties
key string required
put object
1 nested properties
item string required
update object
3 nested properties
key string required
expression string required
expressionAttributeValues string
scan object
2 nested properties
limit string required
exclusiveStartKey string required
catch yawl.CatchRule[]
yawl.YDBDocumentGet object
key string required
yawl.YDBDocumentPut object
item string required
yawl.YDBDocumentScan object
limit string required
exclusiveStartKey string required
yawl.YDBDocumentUpdate object
key string required
expression string required
expressionAttributeValues string
yawl.YDS object
database string required
topic string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
2 nested properties
body string
partitionKey string
catch yawl.CatchRule[]
yawl.YDSPut object
body string
partitionKey string
yawl.YMQ object
queueArn string required
input string
output string
next string
timeout string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryPolicy object
6 nested properties
errorList enum[] required
errorListMode string
Values: "INCLUDE" "EXCLUDE"
initialDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
maxDelay string
format=regexpattern=^([0-9]+\.?[0-9]*|\.[0-9]+)s$
retryCount integer
backoffRate number
put object
1 nested properties
body string
catch yawl.CatchRule[]
yawl.YMQPut object
body string