Flow Filters

Gets the details of a specific flow filter by its object identifier.

get

Retrieves the details of a flow filter using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow filter.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Query parameters

includeOptionsbooleanOptional

Whether to include filter options in the response.

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "filterDataTypeId": 1,
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "fuzzyMatch": true,
      "isYes": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "Equal",
      "decimalAnswer": 1,
      "textAnswer": "text",
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        {
          "fuzzyMatch": true,
          "text": "text"
        }
      ],
      "allCategoriesMatch": true,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "label": "text",
        "description": "text",
        "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "question": "text",
        "questionJson": {
          "type": "text",
          "content": [
            {
              "type": "text",
              "text": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              },
              "marks": [
                {
                  "type": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  }
                }
              ],
              "content": [
                {
                  "type": "text",
                  "text": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  },
                  "marks": [
                    {
                      "type": "text",
                      "attrs": {
                        "id": "text",
                        "label": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "type": "text",
                        "filterDataTypeId": 1,
                        "properties": [
                          {
                            "type": "text",
                            "attrs": {
                              "type": "text",
                              "uuid": "123e4567-e89b-12d3-a456-426614174000",
                              "id": "text",
                              "label": "text",
                              "renderAs": "text",
                              "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                            }
                          }
                        ],
                        "level": 1,
                        "href": "text",
                        "textAlign": "text"
                      }
                    }
                  ],
                  "content": "[Circular Reference]"
                }
              ]
            }
          ]
        },
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "conditions": [
          {
            "fuzzyMatch": true,
            "isYes": true,
            "minimumDecimalAnswer": 1,
            "maximumDecimalAnswer": 1,
            "decimalOperator": "Equal",
            "decimalAnswer": 1,
            "textAnswer": "text",
            "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "categories": [
              {
                "fuzzyMatch": true,
                "text": "text"
              }
            ],
            "allCategoriesMatch": true,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "promptPredicate": "[Circular Reference]"
          }
        ],
        "promptDataTypeId": 1,
        "dateAdded": "2025-12-06T04:07:51.966Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "minimumValue": 1,
        "maximumValue": 1,
        "found": true,
        "hasChildren": true
      }
    }
  ],
  "promptDataTypeId": 1,
  "dateAdded": "2025-12-06T04:07:51.966Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    {
      "name": "text",
      "colour": 0,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "colourHex": "text"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true
}

Updates an existing flow filter by its object identifier.

put

Updates the details of an existing flow filter using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow filter to update.

playbookIdentifierstringRequired

flowIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

labelstring | nullableRequired

descriptionstring | nullableRequired

modelIdentifierstring · uuid | nullableOptional

questionstring | nullableOptional

parentObjectIdentifierstring · uuid | nullableOptional

promptDataTypeIdinteger · int32Required

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

put

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2163

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "filterDataTypeId": 1,
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "fuzzyMatch": true,
      "isYes": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "Equal",
      "decimalAnswer": 1,
      "textAnswer": "text",
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        {
          "fuzzyMatch": true,
          "text": "text"
        }
      ],
      "allCategoriesMatch": true
    }
  ],
  "promptDataTypeId": 1
}

application/jsontext/jsonapplication/*+json

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "filterDataTypeId": 1,
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "fuzzyMatch": true,
      "isYes": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "Equal",
      "decimalAnswer": 1,
      "textAnswer": "text",
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        {
          "fuzzyMatch": true,
          "text": "text"
        }
      ],
      "allCategoriesMatch": true,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "label": "text",
        "description": "text",
        "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "question": "text",
        "questionJson": {
          "type": "text",
          "content": [
            {
              "type": "text",
              "text": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              },
              "marks": [
                {
                  "type": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  }
                }
              ],
              "content": [
                {
                  "type": "text",
                  "text": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  },
                  "marks": [
                    {
                      "type": "text",
                      "attrs": {
                        "id": "text",
                        "label": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "type": "text",
                        "filterDataTypeId": 1,
                        "properties": [
                          {
                            "type": "text",
                            "attrs": {
                              "type": "text",
                              "uuid": "123e4567-e89b-12d3-a456-426614174000",
                              "id": "text",
                              "label": "text",
                              "renderAs": "text",
                              "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                            }
                          }
                        ],
                        "level": 1,
                        "href": "text",
                        "textAlign": "text"
                      }
                    }
                  ],
                  "content": "[Circular Reference]"
                }
              ]
            }
          ]
        },
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "conditions": [
          {
            "fuzzyMatch": true,
            "isYes": true,
            "minimumDecimalAnswer": 1,
            "maximumDecimalAnswer": 1,
            "decimalOperator": "Equal",
            "decimalAnswer": 1,
            "textAnswer": "text",
            "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "categories": [
              {
                "fuzzyMatch": true,
                "text": "text"
              }
            ],
            "allCategoriesMatch": true,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "promptPredicate": "[Circular Reference]"
          }
        ],
        "promptDataTypeId": 1,
        "dateAdded": "2025-12-06T04:07:51.966Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "minimumValue": 1,
        "maximumValue": 1,
        "found": true,
        "hasChildren": true
      }
    }
  ],
  "promptDataTypeId": 1,
  "dateAdded": "2025-12-06T04:07:51.966Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    {
      "name": "text",
      "colour": 0,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "colourHex": "text"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true
}

Gets all flow filters for the specified flow.

get

Retrieves a paginated list of all flow filters for the specified flow, with optional search and sorting.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Query parameters

includeOptionsbooleanOptional

Whether to include filter options in the response.

flattenbooleanOptional

Whether to flatten the filter tree.

parentObjectIdentifierstring · uuidOptional

Optional parent object identifier.

pageNumberinteger · int32Optional

The page number for paginated results.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter results.

sortinginteger · enumOptional

The sorting option for the results.

Possible values:

descbooleanOptional

Whether to sort in descending order.

Default: true

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters

HTTPcURLJavaScriptPython

GET /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "label": "text",
    "description": "text",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "filterDataTypeId": 1,
            "properties": [
              {
                "type": "text",
                "attrs": {
                  "type": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "id": "text",
                  "label": "text",
                  "renderAs": "text",
                  "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                }
              }
            ],
            "level": 1,
            "href": "text",
            "textAlign": "text"
          },
          "marks": [
            {
              "type": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              }
            }
          ],
          "content": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "conditions": [
      {
        "fuzzyMatch": true,
        "isYes": true,
        "minimumDecimalAnswer": 1,
        "maximumDecimalAnswer": 1,
        "decimalOperator": "Equal",
        "decimalAnswer": 1,
        "textAnswer": "text",
        "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "categories": [
          {
            "fuzzyMatch": true,
            "text": "text"
          }
        ],
        "allCategoriesMatch": true,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptPredicate": {
          "label": "text",
          "description": "text",
          "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "question": "text",
          "questionJson": {
            "type": "text",
            "content": [
              {
                "type": "text",
                "text": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                },
                "marks": [
                  {
                    "type": "text",
                    "attrs": {
                      "id": "text",
                      "label": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "type": "text",
                      "filterDataTypeId": 1,
                      "properties": [
                        {
                          "type": "text",
                          "attrs": {
                            "type": "text",
                            "uuid": "123e4567-e89b-12d3-a456-426614174000",
                            "id": "text",
                            "label": "text",
                            "renderAs": "text",
                            "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                          }
                        }
                      ],
                      "level": 1,
                      "href": "text",
                      "textAlign": "text"
                    }
                  }
                ],
                "content": [
                  "[Circular Reference]"
                ]
              }
            ]
          },
          "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "conditions": [
            "[Circular Reference]"
          ],
          "promptDataTypeId": 1,
          "dateAdded": "2025-12-06T04:07:51.966Z",
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "categories": [
            {
              "name": "text",
              "colour": 0,
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
              "colourHex": "text"
            }
          ],
          "minimumValue": 1,
          "maximumValue": 1,
          "found": true,
          "hasChildren": true
        }
      }
    ],
    "promptDataTypeId": 1,
    "dateAdded": "2025-12-06T04:07:51.966Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "categories": [
      {
        "name": "text",
        "colour": 0,
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "colourHex": "text"
      }
    ],
    "minimumValue": 1,
    "maximumValue": 1,
    "found": true,
    "hasChildren": true
  }
]

Creates a new flow filter for the specified flow.

post

Creates a new flow filter for the specified flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

flowIdentifierstringRequired

Query parameters

parentResourceObjectIdentifierstring · uuidOptional

The object identifier of the flow.

Body

application/jsontext/jsonapplication/*+json

labelstring | nullableRequired

descriptionstring | nullableRequired

modelIdentifierstring · uuid | nullableOptional

questionstring | nullableOptional

parentObjectIdentifierstring · uuid | nullableOptional

promptDataTypeIdinteger · int32Required

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post

/playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters

HTTPcURLJavaScriptPython

POST /playbooks/{playbookIdentifier}/flows/{flowIdentifier}/filters HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2163

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "filterDataTypeId": 1,
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "fuzzyMatch": true,
      "isYes": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "Equal",
      "decimalAnswer": 1,
      "textAnswer": "text",
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        {
          "fuzzyMatch": true,
          "text": "text"
        }
      ],
      "allCategoriesMatch": true
    }
  ],
  "promptDataTypeId": 1
}

application/jsontext/jsonapplication/*+json

{
  "label": "text",
  "description": "text",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "filterDataTypeId": 1,
          "properties": [
            {
              "type": "text",
              "attrs": {
                "type": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "id": "text",
                "label": "text",
                "renderAs": "text",
                "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
              }
            }
          ],
          "level": 1,
          "href": "text",
          "textAlign": "text"
        },
        "marks": [
          {
            "type": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            }
          }
        ],
        "content": [
          {
            "type": "text",
            "text": "text",
            "attrs": {
              "id": "text",
              "label": "text",
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "type": "text",
              "filterDataTypeId": 1,
              "properties": [
                {
                  "type": "text",
                  "attrs": {
                    "type": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "id": "text",
                    "label": "text",
                    "renderAs": "text",
                    "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                  }
                }
              ],
              "level": 1,
              "href": "text",
              "textAlign": "text"
            },
            "marks": [
              {
                "type": "text",
                "attrs": {
                  "id": "text",
                  "label": "text",
                  "uuid": "123e4567-e89b-12d3-a456-426614174000",
                  "type": "text",
                  "filterDataTypeId": 1,
                  "properties": [
                    {
                      "type": "text",
                      "attrs": {
                        "type": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "id": "text",
                        "label": "text",
                        "renderAs": "text",
                        "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                      }
                    }
                  ],
                  "level": 1,
                  "href": "text",
                  "textAlign": "text"
                }
              }
            ],
            "content": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "fuzzyMatch": true,
      "isYes": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "Equal",
      "decimalAnswer": 1,
      "textAnswer": "text",
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categories": [
        {
          "fuzzyMatch": true,
          "text": "text"
        }
      ],
      "allCategoriesMatch": true,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptPredicate": {
        "label": "text",
        "description": "text",
        "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "question": "text",
        "questionJson": {
          "type": "text",
          "content": [
            {
              "type": "text",
              "text": "text",
              "attrs": {
                "id": "text",
                "label": "text",
                "uuid": "123e4567-e89b-12d3-a456-426614174000",
                "type": "text",
                "filterDataTypeId": 1,
                "properties": [
                  {
                    "type": "text",
                    "attrs": {
                      "type": "text",
                      "uuid": "123e4567-e89b-12d3-a456-426614174000",
                      "id": "text",
                      "label": "text",
                      "renderAs": "text",
                      "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                    }
                  }
                ],
                "level": 1,
                "href": "text",
                "textAlign": "text"
              },
              "marks": [
                {
                  "type": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  }
                }
              ],
              "content": [
                {
                  "type": "text",
                  "text": "text",
                  "attrs": {
                    "id": "text",
                    "label": "text",
                    "uuid": "123e4567-e89b-12d3-a456-426614174000",
                    "type": "text",
                    "filterDataTypeId": 1,
                    "properties": [
                      {
                        "type": "text",
                        "attrs": {
                          "type": "text",
                          "uuid": "123e4567-e89b-12d3-a456-426614174000",
                          "id": "text",
                          "label": "text",
                          "renderAs": "text",
                          "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                        }
                      }
                    ],
                    "level": 1,
                    "href": "text",
                    "textAlign": "text"
                  },
                  "marks": [
                    {
                      "type": "text",
                      "attrs": {
                        "id": "text",
                        "label": "text",
                        "uuid": "123e4567-e89b-12d3-a456-426614174000",
                        "type": "text",
                        "filterDataTypeId": 1,
                        "properties": [
                          {
                            "type": "text",
                            "attrs": {
                              "type": "text",
                              "uuid": "123e4567-e89b-12d3-a456-426614174000",
                              "id": "text",
                              "label": "text",
                              "renderAs": "text",
                              "parentMentionId": "123e4567-e89b-12d3-a456-426614174000"
                            }
                          }
                        ],
                        "level": 1,
                        "href": "text",
                        "textAlign": "text"
                      }
                    }
                  ],
                  "content": "[Circular Reference]"
                }
              ]
            }
          ]
        },
        "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "conditions": [
          {
            "fuzzyMatch": true,
            "isYes": true,
            "minimumDecimalAnswer": 1,
            "maximumDecimalAnswer": 1,
            "decimalOperator": "Equal",
            "decimalAnswer": 1,
            "textAnswer": "text",
            "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "categories": [
              {
                "fuzzyMatch": true,
                "text": "text"
              }
            ],
            "allCategoriesMatch": true,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "promptPredicate": "[Circular Reference]"
          }
        ],
        "promptDataTypeId": 1,
        "dateAdded": "2025-12-06T04:07:51.966Z",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "categories": [
          {
            "name": "text",
            "colour": 0,
            "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
            "colourHex": "text"
          }
        ],
        "minimumValue": 1,
        "maximumValue": 1,
        "found": true,
        "hasChildren": true
      }
    }
  ],
  "promptDataTypeId": 1,
  "dateAdded": "2025-12-06T04:07:51.966Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categories": [
    {
      "name": "text",
      "colour": 0,
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "colourHex": "text"
    }
  ],
  "minimumValue": 1,
  "maximumValue": 1,
  "found": true,
  "hasChildren": true
}