Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Playbook Assembly Reference Conditions

Get a paginated list of conditions for an assembly reference.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Query parameters
pageinteger · int32OptionalDefault: 1
pageSizeinteger · int32OptionalDefault: 20
Responses
200

OK

totalCountinteger · int32Optional
get/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions
GET /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "assemblyReferenceObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isYes": true,
      "fuzzyMatch": true,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "textAnswer": "text",
      "allCategoriesMatch": true,
      "decimalAnswer": 1,
      "decimalOperator": "equal",
      "dateOperator": "equal",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "dateAnswer": "2026-01-01T00:00:00.000Z",
      "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "categoryConditions": [
        {
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
          "fuzzyMatch": true,
          "text": "text"
        }
      ]
    }
  ],
  "totalCount": 1
}

Create a new condition for an assembly reference. Category conditions may be created alongside it.

post
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
referenceObjectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
assemblyObjectIdentifierstringRequired
Body
isYesboolean · nullableOptional
fuzzyMatchbooleanOptional
minimumDecimalAnswernumber · double · nullableOptional
maximumDecimalAnswernumber · double · nullableOptional
textAnswerstring · nullableOptional
allCategoriesMatchbooleanOptional
decimalAnswernumber · double · nullableOptional
decimalOperatorstring · enumOptionalPossible values:
dateOperatorstring · enumOptionalPossible values:
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
dateAnswerstring · date-time · nullableOptional
playbookPromptConditionIdentifierstring · uuidOptional
targetPromptObjectIdentifierstring · uuidOptional
Responses
201

Created

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
isYesboolean · nullableOptional
fuzzyMatchbooleanOptional
minimumDecimalAnswernumber · double · nullableOptional
maximumDecimalAnswernumber · double · nullableOptional
textAnswerstring · nullableOptional
allCategoriesMatchbooleanOptional
decimalAnswernumber · double · nullableOptional
decimalOperatorstring · enumOptionalPossible values:
dateOperatorstring · enumOptionalPossible values:
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
dateAnswerstring · date-time · nullableOptional
playbookPromptConditionIdentifierstring · uuidOptional
targetPromptObjectIdentifierstring · uuidOptional
post/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions
POST /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 513

{
  "isYes": true,
  "fuzzyMatch": true,
  "minimumDecimalAnswer": 1,
  "maximumDecimalAnswer": 1,
  "textAnswer": "text",
  "allCategoriesMatch": true,
  "decimalAnswer": 1,
  "decimalOperator": "equal",
  "dateOperator": "equal",
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z",
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categoryConditions": [
    {
      "fuzzyMatch": true,
      "text": "text"
    }
  ]
}
{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isYes": true,
  "fuzzyMatch": true,
  "minimumDecimalAnswer": 1,
  "maximumDecimalAnswer": 1,
  "textAnswer": "text",
  "allCategoriesMatch": true,
  "decimalAnswer": 1,
  "decimalOperator": "equal",
  "dateOperator": "equal",
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z",
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categoryConditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "fuzzyMatch": true,
      "text": "text"
    }
  ]
}

Get a specific condition by object identifier.

get
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Responses
200

OK

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
isYesboolean · nullableOptional
fuzzyMatchbooleanOptional
minimumDecimalAnswernumber · double · nullableOptional
maximumDecimalAnswernumber · double · nullableOptional
textAnswerstring · nullableOptional
allCategoriesMatchbooleanOptional
decimalAnswernumber · double · nullableOptional
decimalOperatorstring · enumOptionalPossible values:
dateOperatorstring · enumOptionalPossible values:
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
dateAnswerstring · date-time · nullableOptional
playbookPromptConditionIdentifierstring · uuidOptional
targetPromptObjectIdentifierstring · uuidOptional
get/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier}
GET /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isYes": true,
  "fuzzyMatch": true,
  "minimumDecimalAnswer": 1,
  "maximumDecimalAnswer": 1,
  "textAnswer": "text",
  "allCategoriesMatch": true,
  "decimalAnswer": 1,
  "decimalOperator": "equal",
  "dateOperator": "equal",
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z",
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categoryConditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "fuzzyMatch": true,
      "text": "text"
    }
  ]
}

Update an existing condition. Category conditions are managed through their own endpoints.

put
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Body
isYesboolean · nullableOptional
fuzzyMatchbooleanOptional
minimumDecimalAnswernumber · double · nullableOptional
maximumDecimalAnswernumber · double · nullableOptional
textAnswerstring · nullableOptional
allCategoriesMatchbooleanOptional
decimalAnswernumber · double · nullableOptional
decimalOperatorstring · enumOptionalPossible values:
dateOperatorstring · enumOptionalPossible values:
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
dateAnswerstring · date-time · nullableOptional
playbookPromptConditionIdentifierstring · uuidOptional
targetPromptObjectIdentifierstring · uuidOptional
Responses
200

OK

objectIdentifierstring · uuidOptional
assemblyReferenceObjectIdentifierstring · uuidOptional
isYesboolean · nullableOptional
fuzzyMatchbooleanOptional
minimumDecimalAnswernumber · double · nullableOptional
maximumDecimalAnswernumber · double · nullableOptional
textAnswerstring · nullableOptional
allCategoriesMatchbooleanOptional
decimalAnswernumber · double · nullableOptional
decimalOperatorstring · enumOptionalPossible values:
dateOperatorstring · enumOptionalPossible values:
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
dateAnswerstring · date-time · nullableOptional
playbookPromptConditionIdentifierstring · uuidOptional
targetPromptObjectIdentifierstring · uuidOptional
put/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier}
PUT /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "isYes": true,
  "fuzzyMatch": true,
  "minimumDecimalAnswer": 1,
  "maximumDecimalAnswer": 1,
  "textAnswer": "text",
  "allCategoriesMatch": true,
  "decimalAnswer": 1,
  "decimalOperator": "equal",
  "dateOperator": "equal",
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z",
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isYes": true,
  "fuzzyMatch": true,
  "minimumDecimalAnswer": 1,
  "maximumDecimalAnswer": 1,
  "textAnswer": "text",
  "allCategoriesMatch": true,
  "decimalAnswer": 1,
  "decimalOperator": "equal",
  "dateOperator": "equal",
  "startDate": "2026-01-01T00:00:00.000Z",
  "endDate": "2026-01-01T00:00:00.000Z",
  "dateAnswer": "2026-01-01T00:00:00.000Z",
  "playbookPromptConditionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "targetPromptObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "categoryConditions": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "fuzzyMatch": true,
      "text": "text"
    }
  ]
}

Delete a condition from an assembly reference.

delete
Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Path parameters
objectIdentifierstring · uuidRequired
playbookIdentifierstringRequired
assemblyObjectIdentifierstringRequired
referenceObjectIdentifierstringRequired
Responses
204

No Content

No content
delete/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier}
DELETE /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousPlaybook Assembly Reference Category ConditionsNextPlaybook Assembly Reference Template Columns

Last updated