> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Playbook Paths

API operations for playbook paths. Browse the routes below for parameters, request examples, and responses.

API version: Selected per operation

## List exit paths

Returns every exit path of one playbook in one response. An exit path is a named way out of a playbook that the model takes when its exit condition holds, and workflows use its ID to link the path's port.

### Endpoint

```http
GET /v1/stable/playbook-path
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `playbookID`

Required · string

The ID of the playbook the exit path belongs to.

```json
{
  "type": "string",
  "description": "The ID of the playbook the exit path belongs to."
}
```

### Responses

#### 200

Returns the exit paths of the playbook, each with its ID, name, exit condition and timestamps.

Schema:

```json
{
  "$ref": "#/components/schemas/StablePlaybookPathListResponse"
}
```

Example:

```json
{
  "paths": [
    {
      "id": "<string>",
      "playbookID": "<string>",
      "name": "<string>",
      "description": "<string>",
      "requiredVariables": [
        "<StableRequiredVariable>"
      ],
      "messages": "<StableToolMessages>",
      "createdAt": "2026-09-10T00:00:00.000Z",
      "updatedAt": "2026-09-10T00:00:00.000Z"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request GET \
  --url 'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.get(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf playbook path list --project-id <projectID> --environment-alias <environmentAlias> --playbook-id <playbookID>
```


## Create exit path

Adds an exit path to a playbook; the model leaves the playbook through it when the path's description holds. Exit paths take effect when the playbook runs from a Playbook or Operator step in a workflow, where the new path appears as a port with no link.

### Endpoint

```http
POST /v1/stable/playbook-path
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StablePlaybookPathCreateRequest"
      }
    }
  }
}
```

### Responses

#### 201

Returns the created exit path, including the ID assigned to it.

Schema:

```json
{
  "$ref": "#/components/schemas/StablePlaybookPathResponse"
}
```

Example:

```json
{
  "path": {
    "id": "<string>",
    "playbookID": "<string>",
    "name": "<string>",
    "description": "<string>",
    "requiredVariables": [
      {
        "variableOrEntityID": "<string>",
        "description": "<string>"
      }
    ],
    "messages": {
      "generative": {
        "execution": "<StableToolMessageGenerative>",
        "failure": "<StableToolMessageGenerative>",
        "delay": "<StableToolMessageGenerative>",
        "completion": "<StableToolMessageGenerative>"
      },
      "delayMessageID": "<string>",
      "failureMessageID": "<string>",
      "executionMessageID": "<string>",
      "completionMessageID": "<string>",
      "delayMessageSeconds": 0
    },
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z"
  },
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request POST \
  --url 'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "playbookID": "<string>",
  "name": "<string>",
  "description": null,
  "requiredVariables": [],
  "messages": null
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "playbookID": "<string>",
    "name": "<string>",
    "description": null,
    "requiredVariables": [],
    "messages": null
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.post(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path?projectID=<projectID>&environmentAlias=<environmentAlias>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "playbookID": "<string>",
      "name": "<string>",
      "description": None,
      "requiredVariables": [],
      "messages": None
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf playbook path create --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "playbookID": "<string>",
  "name": "<string>",
  "description": null,
  "requiredVariables": [],
  "messages": null
}
JSON
```


## Update exit path

Changes the name, the exit condition, or both on an exit path. Workflow ports follow the path by ID, so links made on it stay in place.

### Endpoint

```http
PATCH /v1/stable/playbook-path/{pathID}
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `pathID`

Required · string

The ID of the exit path to operate on.

```json
{
  "type": "string"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `playbookID`

Required · string

The ID of the playbook the exit path belongs to.

```json
{
  "type": "string",
  "description": "The ID of the playbook the exit path belongs to."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StablePlaybookPathUpdateRequest"
          }
        ]
      }
    }
  }
}
```

### Responses

#### 200

Returns the updated exit path.

Schema:

```json
{
  "$ref": "#/components/schemas/StablePlaybookPathResponse"
}
```

Example:

```json
{
  "path": {
    "id": "<string>",
    "playbookID": "<string>",
    "name": "<string>",
    "description": "<string>",
    "requiredVariables": [
      {
        "variableOrEntityID": "<string>",
        "description": "<string>"
      }
    ],
    "messages": {
      "generative": {
        "execution": "<StableToolMessageGenerative>",
        "failure": "<StableToolMessageGenerative>",
        "delay": "<StableToolMessageGenerative>",
        "completion": "<StableToolMessageGenerative>"
      },
      "delayMessageID": "<string>",
      "failureMessageID": "<string>",
      "executionMessageID": "<string>",
      "completionMessageID": "<string>",
      "delayMessageSeconds": 0
    },
    "createdAt": "2026-09-10T00:00:00.000Z",
    "updatedAt": "2026-09-10T00:00:00.000Z"
  },
  "unresolvedReferences": [
    {
      "path": "<string>",
      "token": "<string>",
      "reason": "unknown"
    }
  ]
}
```

### Request examples

#### cURL

```bash
curl --request PATCH \
  --url 'https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "requiredVariables": [
    {
      "variableOrEntityID": "<string>",
      "description": null
    }
  ],
  "messages": {
    "generative": {
      "execution": "<StableToolMessageGenerative>",
      "failure": "<StableToolMessageGenerative>",
      "delay": "<StableToolMessageGenerative>",
      "completion": "<StableToolMessageGenerative>"
    },
    "delayMessageID": "<string>",
    "failureMessageID": "<string>",
    "executionMessageID": "<string>",
    "completionMessageID": "<string>",
    "delayMessageSeconds": 0
  }
}'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "<string>",
    "description": "<string>",
    "requiredVariables": [
      {
        "variableOrEntityID": "<string>",
        "description": null
      }
    ],
    "messages": {
      "generative": {
        "execution": "<StableToolMessageGenerative>",
        "failure": "<StableToolMessageGenerative>",
        "delay": "<StableToolMessageGenerative>",
        "completion": "<StableToolMessageGenerative>"
      },
      "delayMessageID": "<string>",
      "failureMessageID": "<string>",
      "executionMessageID": "<string>",
      "completionMessageID": "<string>",
      "delayMessageSeconds": 0
    }
  }),
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.patch(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>',
    headers={'Authorization': 'Bearer <token>'},
    json={
      "name": "<string>",
      "description": "<string>",
      "requiredVariables": [
        {
          "variableOrEntityID": "<string>",
          "description": None
        }
      ],
      "messages": {
        "generative": {
          "execution": "<StableToolMessageGenerative>",
          "failure": "<StableToolMessageGenerative>",
          "delay": "<StableToolMessageGenerative>",
          "completion": "<StableToolMessageGenerative>"
        },
        "delayMessageID": "<string>",
        "failureMessageID": "<string>",
        "executionMessageID": "<string>",
        "completionMessageID": "<string>",
        "delayMessageSeconds": 0
      }
    },
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf playbook path update --path-id <pathID> --project-id <projectID> --environment-alias <environmentAlias> --playbook-id <playbookID> <<'JSON'
{
  "name": "<string>",
  "description": "<string>",
  "requiredVariables": [
    {
      "variableOrEntityID": "<string>",
      "description": null
    }
  ],
  "messages": {
    "generative": {
      "execution": "<StableToolMessageGenerative>",
      "failure": "<StableToolMessageGenerative>",
      "delay": "<StableToolMessageGenerative>",
      "completion": "<StableToolMessageGenerative>"
    },
    "delayMessageID": "<string>",
    "failureMessageID": "<string>",
    "executionMessageID": "<string>",
    "completionMessageID": "<string>",
    "delayMessageSeconds": 0
  }
}
JSON
```


## Delete exit path

Deletes one exit path from a playbook, together with its required variables. The response carries only a confirmation message, so refetch the playbook's paths to see what is left.

### Endpoint

```http
DELETE /v1/stable/playbook-path/{pathID}
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `pathID`

Required · string

The ID of the exit path to operate on.

```json
{
  "type": "string"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

#### `playbookID`

Required · string

The ID of the playbook the exit path belongs to.

```json
{
  "type": "string",
  "description": "The ID of the playbook the exit path belongs to."
}
```

### Responses

#### 200

Confirms the exit path was deleted.

Schema:

```json
{
  "$ref": "#/components/schemas/StableDeleteResponse"
}
```

Example:

```json
{
  "message": "<string>"
}
```

### Request examples

#### cURL

```bash
curl --request DELETE \
  --url 'https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>' \
  --header 'Authorization: Bearer <token>'
```

#### JavaScript

```javascript
const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer <token>',
  },
});
const data = await response.json();
```

#### Python

```python
import requests

response = requests.delete(
    'https://realtime-api.voiceflow.com/v1/stable/playbook-path/<pathID>?projectID=<projectID>&environmentAlias=<environmentAlias>&playbookID=<playbookID>',
    headers={'Authorization': 'Bearer <token>'},
)
data = response.json()
```

#### Voiceflow CLI

```bash
vf playbook path delete --path-id <pathID> --project-id <projectID> --environment-alias <environmentAlias> --playbook-id <playbookID>
```


## Schema definitions

### MarkdownLikeString

```json
{
  "type": "string",
  "description": "Message text shown to the end user. Limited markdown: **bold**, _italic_, <u>underline</u>, ~~strikethrough~~, [label](url). {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \\ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here."
}
```

### StableDeleteResponse

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A human-readable message confirming the deletion."
    }
  },
  "required": [
    "message"
  ]
}
```

### StablePlaybookPath

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "playbookID": {
      "type": "string",
      "description": "The ID of the playbook this exit path belongs to."
    },
    "name": {
      "type": "string",
      "description": "The name of the exit path. It labels the port on every Playbook step that runs this playbook, and the runtime turns it into the name of the exit tool the model calls."
    },
    "description": {
      "nullable": true,
      "description": "The exit condition: the model reads it to decide when to leave the playbook through this path.",
      "type": "string"
    },
    "requiredVariables": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableRequiredVariable"
      },
      "description": "The variables or entities the model must fill before it can leave through this path, in the order the editor shows them."
    },
    "messages": {
      "nullable": true,
      "description": "What the agent says as it leaves through this path, in the shape tool messages take: a message ID per slot, and generative examples. Null when it says nothing.",
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    }
  },
  "required": [
    "id",
    "playbookID",
    "name",
    "description",
    "requiredVariables",
    "messages",
    "createdAt",
    "updatedAt"
  ]
}
```

### StablePlaybookPathCreateRequest

```json
{
  "type": "object",
  "properties": {
    "playbookID": {
      "type": "string",
      "description": "The ID of the playbook to add the exit path to."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The name of the exit path, trimmed. Use Latin letters, digits, spaces, hyphens and underscores, as the editor does: the runtime turns the name into the snake_case name of the exit tool the model calls."
    },
    "description": {
      "default": null,
      "nullable": true,
      "description": "The exit condition: the model reads it to decide when to leave the playbook through this path.",
      "type": "string"
    },
    "requiredVariables": {
      "default": [],
      "description": "The variables or entities the model must fill before it can leave through this path, in order.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableRequiredVariableInput"
      }
    },
    "messages": {
      "default": null,
      "description": "What the agent says as it leaves through this path. Send only a message ID that nothing else uses: no other step in any workflow, no reprompt, no agent and no playbook. For the same words in a second place, create a new message with that text.",
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    }
  },
  "required": [
    "playbookID",
    "name"
  ],
  "additionalProperties": false
}
```

### StablePlaybookPathListResponse

```json
{
  "type": "object",
  "properties": {
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StablePlaybookPath"
      }
    }
  },
  "required": [
    "paths"
  ]
}
```

### StablePlaybookPathResponse

```json
{
  "type": "object",
  "properties": {
    "path": {
      "$ref": "#/components/schemas/StablePlaybookPath"
    },
    "unresolvedReferences": {
      "description": "References this write kept as literal text instead of binding, each with the reason. The write still succeeded.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableUnresolvedReference"
      }
    }
  },
  "required": [
    "path"
  ]
}
```

### StablePlaybookPathUpdateRequest

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "The name of the exit path, trimmed. Use Latin letters, digits, spaces, hyphens and underscores, as the editor does: the runtime turns the name into the snake_case name of the exit tool the model calls."
    },
    "description": {
      "nullable": true,
      "description": "The exit condition: the model reads it to decide when to leave the playbook through this path.",
      "type": "string"
    },
    "requiredVariables": {
      "description": "Replaces the stored list, in order. Leave it out to keep it; send [] to remove every one.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableRequiredVariableInput"
      }
    },
    "messages": {
      "description": "Replaces the stored messages whole. Send null to remove them; leave it out to keep them. Send only a message ID that nothing else uses: no other step in any workflow, no reprompt, no agent and no playbook. For the same words in a second place, create a new message with that text.",
      "nullable": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StableToolMessages"
        }
      ]
    }
  },
  "additionalProperties": false
}
```

### StableRequiredVariable

```json
{
  "type": "object",
  "properties": {
    "variableOrEntityID": {
      "nullable": true,
      "description": "The ID of the variable or entity the model must fill, or null when the stored row names neither.",
      "type": "string"
    },
    "description": {
      "nullable": true,
      "description": "What the model is told to collect, or null.",
      "type": "string"
    }
  },
  "required": [
    "variableOrEntityID",
    "description"
  ]
}
```

### StableRequiredVariableInput

```json
{
  "type": "object",
  "properties": {
    "variableOrEntityID": {
      "type": "string",
      "minLength": 1,
      "description": "The ID of a variable or an entity in this environment. List each one once."
    },
    "description": {
      "default": null,
      "description": "What the model is told to collect. Leave it out for none.",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "variableOrEntityID"
  ],
  "additionalProperties": false
}
```

### StableToolMessageGenerative

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "examples": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MarkdownLikeString"
      }
    }
  },
  "required": [
    "enabled"
  ]
}
```

### StableToolMessages

```json
{
  "type": "object",
  "properties": {
    "generative": {
      "type": "object",
      "properties": {
        "execution": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "failure": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "delay": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        },
        "completion": {
          "allOf": [
            {
              "$ref": "#/components/schemas/StableToolMessageGenerative"
            }
          ]
        }
      }
    },
    "delayMessageID": {
      "nullable": true,
      "type": "string"
    },
    "failureMessageID": {
      "nullable": true,
      "type": "string"
    },
    "executionMessageID": {
      "nullable": true,
      "type": "string"
    },
    "completionMessageID": {
      "nullable": true,
      "type": "string"
    },
    "delayMessageSeconds": {
      "nullable": true,
      "type": "number"
    }
  },
  "required": [
    "delayMessageID",
    "failureMessageID",
    "executionMessageID",
    "completionMessageID",
    "delayMessageSeconds"
  ]
}
```

### StableUnresolvedReference

```json
{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "Dotted path of the field that carried it, e.g. `knowledgeBaseTool.filters[0].defaultValue`."
    },
    "token": {
      "type": "string",
      "description": "The reference as written, without braces."
    },
    "reason": {
      "type": "string",
      "enum": [
        "unknown",
        "secret-not-allowed",
        "path-on-non-variable",
        "resource-id",
        "invalid-name",
        "dangling"
      ],
      "description": "`unknown`: no variable or entity of that name. `secret-not-allowed`: the name is a project secret and this field does not accept one. `path-on-non-variable`: only a variable has fields. `resource-id`: a bare resource id, not a name. `invalid-name`: outside the `^\\w{1,64}$` name grammar. `dangling`: the reference rendered as a bare id, because its row is gone or its name is outside the name grammar.",
      "x-enumNames": [
        "UNKNOWN",
        "SECRET_NOT_ALLOWED",
        "PATH_ON_NON_VARIABLE",
        "RESOURCE_ID",
        "INVALID_NAME",
        "DANGLING"
      ]
    }
  },
  "required": [
    "path",
    "token",
    "reason"
  ]
}
```
