Playbook Prompts

Get all prompts for a playbook group.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Query parameters

flattenbooleanOptional

parentObjectIdentifierstring · uuidOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts

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

200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "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",
                "promptDataType": "boolean",
                "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]"
          ]
        }
      ]
    },
    "promptDataType": "boolean",
    "orderNumber": 1,
    "hasChildren": true,
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "tokenCount": 1,
    "conditionOperator": "and",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true
  }
]

Create a new prompt for a playbook group.

post

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Body

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

parentObjectIdentifierstring · uuid · nullableOptional

modelIdentifierstring · uuid · nullableOptional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

Responses

201

Created

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

400

Bad Request

post/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts

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

{
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditions": [
    {
      "promptPredicateObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "isYes": true,
      "decimalAnswer": 1,
      "minimumDecimalAnswer": 1,
      "maximumDecimalAnswer": 1,
      "decimalOperator": "equal",
      "dateAnswer": "2026-01-01T00:00:00.000Z",
      "startDate": "2026-01-01T00:00:00.000Z",
      "endDate": "2026-01-01T00:00:00.000Z",
      "dateOperator": "equal",
      "categories": [
        {
          "category": "text"
        }
      ]
    }
  ],
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "orderNumber": 1,
  "hasChildren": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "tokenCount": 1,
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

Duplicate a prompt as a new prompt (copies heading, description, prompt text, mentions and conditions).

post

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

promptObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Responses

201

Created

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

400

Bad Request

404

Not Found

post/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{promptObjectIdentifier}/duplicate

POST /playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{promptObjectIdentifier}/duplicate HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "orderNumber": 1,
  "hasChildren": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "tokenCount": 1,
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

Get all prompts across all playbook groups (flattened view).

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

playbookIdentifierstringRequired

Query parameters

flattenbooleanOptional

parentObjectIdentifierstring · uuidOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

get/playbooks/{playbookIdentifier}/prompts

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

200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "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",
                "promptDataType": "boolean",
                "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]"
          ]
        }
      ]
    },
    "promptDataType": "boolean",
    "orderNumber": 1,
    "hasChildren": true,
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "tokenCount": 1,
    "conditionOperator": "and",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true
  }
]

Get a specific prompt by object identifier.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

404

Not Found

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{objectIdentifier}

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

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "orderNumber": 1,
  "hasChildren": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "tokenCount": 1,
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

Update an existing prompt for a playbook group.

put

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Body

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

parentObjectIdentifierstring · uuid · nullableOptional

modelIdentifierstring · uuid · nullableOptional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditboolean · nullableOptional

includeDocumentsboolean · nullableOptional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

400

Bad Request

404

Not Found

409

Conflict

put/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{objectIdentifier}

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

{
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "orderNumber": 1,
  "hasChildren": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "tokenCount": 1,
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

Delete a prompt from a playbook group.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Responses

204

No Content

No content

404

Not Found

409

Conflict

delete/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{objectIdentifier}

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

No content

Get ancestors of a specific prompt by object identifier.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Query parameters

searchTextstringOptional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{objectIdentifier}/ancestors

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

200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "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",
                "promptDataType": "boolean",
                "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]"
          ]
        }
      ]
    },
    "promptDataType": "boolean",
    "orderNumber": 1,
    "hasChildren": true,
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "tokenCount": 1,
    "conditionOperator": "and",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true
  }
]

Get ancestors by parent object identifier.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Query parameters

parentObjectIdentifierstring · uuidOptional

searchTextstringOptional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/ancestors-by-parent

GET /playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/ancestors-by-parent HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "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",
                "promptDataType": "boolean",
                "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]"
          ]
        }
      ]
    },
    "promptDataType": "boolean",
    "orderNumber": 1,
    "hasChildren": true,
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "tokenCount": 1,
    "conditionOperator": "and",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true
  }
]

Filters that the given prompt is allowed to reference in a mention or condition: ancestors plus same-level prompts in the playbook group, with any filter that already mentions the target removed (cycle protection). Pass objectIdentifier when editing an existing prompt; pass parentObjectIdentifier when configuring a new prompt under a parent.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Query parameters

objectIdentifierstring · uuidOptional

parentObjectIdentifierstring · uuidOptional

searchTextstringOptional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/mention-options

GET /playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/mention-options HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "description": "text",
    "question": "text",
    "questionJson": {
      "type": "text",
      "content": [
        {
          "type": "text",
          "text": "text",
          "attrs": {
            "id": "text",
            "label": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "promptDataType": "boolean",
            "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",
                "promptDataType": "boolean",
                "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]"
          ]
        }
      ]
    },
    "promptDataType": "boolean",
    "orderNumber": 1,
    "hasChildren": true,
    "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "dateAdded": "2026-01-01T00:00:00.000Z",
    "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "tokenCount": 1,
    "conditionOperator": "and",
    "reasoningEffort": "none",
    "canEdit": true,
    "includeDocuments": true
  }
]

Update the position of a prompt in the playbook prompt tree.

put

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Body

parentObjectIdentifierstring · uuid · nullableOptional

orderNumberinteger · int32Optional

Responses

200

OK

objectIdentifierstring · uuidRequired

stableObjectIdentifierstring · uuidOptional

groupObjectIdentifierstring · uuidOptional

labelstring · nullableOptional

descriptionstring · nullableOptional

questionstring · nullableOptional

promptDataTypestring · enumOptionalPossible values:

orderNumberinteger · int32 · nullableOptional

hasChildrenboolean · nullableOptional

parentObjectIdentifierstring · uuid · nullableOptional

dateAddedstring · date-timeOptional

modelIdentifierstring · uuid · nullableOptional

tokenCountinteger · int32Optional

conditionOperatorstring · enumOptionalPossible values:

reasoningEffortstring · enumOptionalPossible values:

canEditbooleanOptional

includeDocumentsbooleanOptional

400

Bad Request

409

Conflict

put/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/{objectIdentifier}/position

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

{
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": 1
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "stableObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "label": "text",
  "description": "text",
  "question": "text",
  "questionJson": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "text": "text",
        "attrs": {
          "id": "text",
          "label": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "promptDataType": "boolean",
          "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",
              "promptDataType": "boolean",
              "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",
              "promptDataType": "boolean",
              "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",
                  "promptDataType": "boolean",
                  "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]"
          }
        ]
      }
    ]
  },
  "promptDataType": "boolean",
  "orderNumber": 1,
  "hasChildren": true,
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "dateAdded": "2026-01-01T00:00:00.000Z",
  "modelIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "tokenCount": 1,
  "conditionOperator": "and",
  "reasoningEffort": "none",
  "canEdit": true,
  "includeDocuments": true
}

Get a preview of all prompts for a playbook group.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

groupObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

Query parameters

flattenbooleanOptional

parentObjectIdentifierstring · uuidOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

searchTextstringOptional

sortingstring · enumOptionalPossible values:

descbooleanOptionalDefault: true

Responses

200

OK

totalCountinteger · int32Optional

get/playbooks/{playbookIdentifier}/groups/{groupObjectIdentifier}/prompts/preview

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

200

OK

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "groupObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "label": "text",
      "description": "text",
      "hasChildren": true,
      "promptDataType": "boolean",
      "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "totalCount": 1
}