Flow Group Assignments

Assign a flow group to a flow.

post

Creates a flow group assignment that defines which document collections a flow group runs against within a project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Body

application/jsontext/jsonapplication/*+json

flowGroupObjectIdentifierstring · uuidOptional

Responses

201

Created

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowGroupObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "flowGroupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "collections": [
    {
      "name": "text",
      "useAllDocuments": true,
      "documentObjectIdentifiers": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowGroupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-09T14:48:35.213Z",
  "collections": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "useAllDocuments": true,
      "dateAdded": "2026-07-09T14:48:35.213Z",
      "entries": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2026-07-09T14:48:35.213Z"
        }
      ]
    }
  ]
}

Count active flow group assignments.

get

Returns how many flow group assignments are currently active for the specified flow.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

flowObjectIdentifierstring · uuidRequired

projectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

integer · int32Optional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments/active-assignments

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments/active-assignments HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Get a flow group assignment by id.

get

Returns the details of a single flow group assignment, including its configured document collections.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

projectIdentifierstringRequired

flowObjectIdentifierstringRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

flowGroupObjectIdentifierstring · uuidOptional

dateAddedstring · date-timeOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments/{objectIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/flows/{flowObjectIdentifier}/flow-group-assignments/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "flowGroupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-07-09T14:48:35.213Z",
  "collections": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "useAllDocuments": true,
      "dateAdded": "2026-07-09T14:48:35.213Z",
      "entries": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "documentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "dateAdded": "2026-07-09T14:48:35.213Z"
        }
      ]
    }
  ]
}