Flows

Retrieves a paginated list of flows for the specified project.

get

Retrieves a paginated list of flows for the specified project, optionally filtered and sorted.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Query parameters

flattenbooleanOptional

Whether to flatten the flow structure.

parentObjectIdentifierstring · uuidOptional

Optional parent object identifier.

pageNumberinteger · int32Optional

The page number to retrieve.

pageSizeinteger · int32Optional

The number of items per page.

searchTextstringOptional

Optional search text to filter flows.

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

/projects/{projectIdentifier}/flows

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/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:05:06.288Z",
    "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 project.

post

Creates a new flow for the specified project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

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

post

/projects/{projectIdentifier}/flows

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flows 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:05:06.288Z",
  "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 in the flow directory.

post

Creates a new folder in the flow directory.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

namestring | nullableRequired

parentObjectIdentifierstring · uuid | nullableOptional

Responses

200

OK

text/plainapplication/jsontext/json

400

Bad Request

403

Forbidden

post

/projects/{projectIdentifier}/flows/folder

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/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",
  "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:05:06.288Z",
  "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"
    }
  ]
}

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 unique identifier of the flow to stop.

projectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

patch

/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/stop

HTTPcURLJavaScriptPython

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

No content

Retrieves a flow by its object identifier.

get

Retrieves a flow by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/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:05:06.288Z",
  "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 a flow by its object identifier.

put

Updates a flow by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the flow to update.

projectIdentifierstringRequired

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

/projects/{projectIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

PUT /projects/{projectIdentifier}/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:05:06.288Z",
  "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 by its object identifier.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the flow to delete.

projectIdentifierstringRequired

Responses

204

No Content

403

Forbidden

404

Not Found

delete

/projects/{projectIdentifier}/flows/{objectIdentifier}

HTTPcURLJavaScriptPython

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

No content

Retrieves the progress of a flow.

get

Get the progress of a flow, calculated by number of filter answers in relation to filters and documents.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the flow.

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

403

Forbidden

404

Not Found

get

/projects/{projectIdentifier}/flows/{objectIdentifier}/progress

HTTPcURLJavaScriptPython

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

{
  "progress": 1
}