Flows

Gets all flows for the specified playbook.

get

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

flattenbooleanOptional

Whether to flatten the flow 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

get

/playbooks/{playbookIdentifier}/flows

HTTPcURLJavaScriptPython

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

[
  {
    "name": "text",
    "description": "text",
    "allDocuments": true,
    "documentTypeMapping": {
      "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
    },
    "documentObjectIdentifiers": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "playbookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2025-12-06T04:17:03.341Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isDirectory": true,
    "hasAssembly": true,
    "hasDocumentAssembly": true,
    "hasChildren": true,
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "flowColumns": [
      {
        "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "promptLabel": "text"
      }
    ]
  }
]

Creates a new flow for the specified playbook.

post

Creates a new flow for the specified playbook.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstring · uuidRequired

The object identifier of the playbook.

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

descriptionstring | nullableRequired

allDocumentsbooleanRequired

documentObjectIdentifiersstring · uuid[] | nullableOptional

parentObjectIdentifierstring · uuid | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

403

Forbidden

post

/playbooks/{playbookIdentifier}/flows

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "allDocuments": true,
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "documentTypeMapping": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "allDocuments": true,
  "documentTypeMapping": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "playbookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:17:03.341Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "hasAssembly": true,
  "hasDocumentAssembly": true,
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "flowColumns": [
    {
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptLabel": "text"
    }
  ]
}

Creates a new folder for flows.

post

Creates a new folder for flows.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

400

Bad Request

403

Forbidden

post

/playbooks/{playbookIdentifier}/flows/folder

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:17:03.341Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Stops a flow that is in progress.

patch

Stop a flow that is in progress.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowObjectIdentifierstring · uuidRequired

The object identifier of the flow to stop.

playbookIdentifierstringRequired

Responses

200

OK

No content

403

Forbidden

404

Not Found

patch

/playbooks/{playbookIdentifier}/flows/{flowObjectIdentifier}/stop

HTTPcURLJavaScriptPython

PATCH /playbooks/{playbookIdentifier}/flows/{flowObjectIdentifier}/stop HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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

get

Retrieves the details of a flow using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

404

Not Found

get

/playbooks/{playbookIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "allDocuments": true,
  "documentTypeMapping": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "playbookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:17:03.341Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "hasAssembly": true,
  "hasDocumentAssembly": true,
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "flowColumns": [
    {
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptLabel": "text"
    }
  ]
}

Updates an existing flow by its object identifier.

put

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

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow to update.

playbookIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

descriptionstring | nullableRequired

allDocumentsbooleanRequired

documentObjectIdentifiersstring · uuid[] | nullableOptional

parentObjectIdentifierstring · uuid | nullableOptional

playbookIdentifierstring · uuid | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

403

Forbidden

404

Not Found

put

/playbooks/{playbookIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "description": "text",
  "allDocuments": true,
  "documentTypeMapping": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "playbookIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "description": "text",
  "allDocuments": true,
  "documentTypeMapping": {
    "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
  },
  "documentObjectIdentifiers": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "playbookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2025-12-06T04:17:03.341Z",
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isDirectory": true,
  "hasAssembly": true,
  "hasDocumentAssembly": true,
  "hasChildren": true,
  "resourceOwner": {
    "email": "text",
    "name": "text",
    "id": "text"
  },
  "flowColumns": [
    {
      "promptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "promptLabel": "text"
    }
  ]
}

Deletes a flow by its object identifier.

delete

Deletes a flow using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow to delete.

playbookIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

delete

/playbooks/{playbookIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content

Gets the progress of a flow by its object identifier.

get

Retrieves the progress of a flow using its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The object identifier of the flow.

playbookIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

404

Not Found

get

/playbooks/{playbookIdentifier}/flows/{objectIdentifier}/progress

HTTPcURLJavaScriptPython

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

{
  "progress": 1
}