> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/prompt-versions/openapi.json](/docs/api/prompt-versions/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# Prompt versions

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

The saved prompt versions of a segment, and restoring one.

Copy and personalization. 3 endpoints under `https://api.ken.so`. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`: see [Authentication](/docs/authentication.md), [Workspaces](/docs/workspaces.md) and [Errors](/docs/errors.md). OpenAPI for this resource only: [/docs/api/prompt-versions/openapi.json](/docs/api/prompt-versions/openapi.json).

- `GET /v1/segments/{segmentId}/prompt-versions` - List a segment's prompt versions (`prompt-versions.list`): [/docs/api/prompt-versions/list.md](/docs/api/prompt-versions/list.md)
- `GET /v1/segments/{segmentId}/prompt-versions/{versionId}` - Get a prompt version (`prompt-versions.get`): [/docs/api/prompt-versions/get.md](/docs/api/prompt-versions/get.md)
- `POST /v1/segments/{segmentId}/prompt-versions/{versionId}/restore` - Restore a prompt version (`prompt-versions.restore`): [/docs/api/prompt-versions/restore.md](/docs/api/prompt-versions/restore.md)

## List a segment's prompt versions

`GET /v1/segments/{segmentId}/prompt-versions` - operationId `prompt-versions.list`

| Permission | Rate limit |
| --- | --- |
| Campaigns view | 12,000 requests a minute per API key |

Returns the segment's prompt versions, oldest first, one page at a time. The list leaves out each version's
prompts: get a version to read them.

Errors:

- `400 validation_failed`: `limit` is outside 1 to 200, or `cursor` is not one Kenso returned.
- `404 not_found`: the segment is not in this workspace.

Requires Campaigns view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/prompt-versions/GET/v1/segments/%7BsegmentId%7D/prompt-versions)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `segmentId` | path | integer (int64) | yes | The segment's id. |
| `limit` | query | integer (int32) | no | Number of prompt versions per page, from 1 to 200, default 50. |
| `cursor` | query | string | no | The `nextCursor` from the previous page. Omit it for the first page. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a list of `PromptVersion`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The version's id. |
| `segmentId` | integer (int64) | The segment the version belongs to. |
| `versionNumber` | integer (int32) | The version's number in the segment's history. |
| `createdAt` | string (date-time) | When the version was saved, in UTC. |
| `createdByUserId` | integer (int64) | The member who saved the version, or null when unknown. |
| `createdByEmail` | string | That member's email, or null when unknown. |
| `isRevert` | boolean | True when a restore made this version. |
| `restoredFromVersionId` | integer (int64) | On a version a restore made, the id of the version it restored. Null otherwise. |
| `restoredFromVersionNumber` | integer (int32) | On a version a restore made, the number of the version it restored. Null otherwise. |
| `restoredFromCreatedAt` | string (date-time) | On a version a restore made, when the restored version was saved, in UTC. Null otherwise. |
| `prompts` | array of PromptVersionPrompt | The version's prompts. Returned when you get one version, and null in the list. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/segments/812/prompt-versions?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "id": 812,
      "segmentId": 812,
      "versionNumber": 1,
      "createdAt": "2026-09-23T15:02:11Z",
      "createdByUserId": 812,
      "createdByEmail": "jane@example.com",
      "isRevert": true,
      "restoredFromVersionId": 812,
      "restoredFromVersionNumber": 1,
      "restoredFromCreatedAt": "2026-09-23T15:02:11Z",
      "prompts": [
        {
          "name": "string",
          "prompt": "string",
          "type": "system",
          "flow": "qualification",
          "order": 1,
          "toOutput": true,
          "toRewrite": 1
        }
      ]
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Get a prompt version

`GET /v1/segments/{segmentId}/prompt-versions/{versionId}` - operationId `prompt-versions.get`

| Permission | Rate limit |
| --- | --- |
| Campaigns view | 12,000 requests a minute per API key |

Returns one version of the segment's prompts, with the prompts as they were saved.

Errors:

- `404 not_found`: the segment is not in this workspace, or the version is not one of its versions.

Requires Campaigns view.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/prompt-versions/GET/v1/segments/%7BsegmentId%7D/prompt-versions/%7BversionId%7D)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `segmentId` | path | integer (int64) | yes | The segment's id. |
| `versionId` | path | integer (int64) | yes | The version's id. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `PromptVersion`.

| Field | Type | Description |
| --- | --- | --- |
| `id` | integer (int64) | The version's id. |
| `segmentId` | integer (int64) | The segment the version belongs to. |
| `versionNumber` | integer (int32) | The version's number in the segment's history. |
| `createdAt` | string (date-time) | When the version was saved, in UTC. |
| `createdByUserId` | integer (int64) | The member who saved the version, or null when unknown. |
| `createdByEmail` | string | That member's email, or null when unknown. |
| `isRevert` | boolean | True when a restore made this version. |
| `restoredFromVersionId` | integer (int64) | On a version a restore made, the id of the version it restored. Null otherwise. |
| `restoredFromVersionNumber` | integer (int32) | On a version a restore made, the number of the version it restored. Null otherwise. |
| `restoredFromCreatedAt` | string (date-time) | On a version a restore made, when the restored version was saved, in UTC. Null otherwise. |
| `prompts` | array of PromptVersionPrompt | The version's prompts. Returned when you get one version, and null in the list. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/segments/812/prompt-versions/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "id": 812,
    "segmentId": 812,
    "versionNumber": 1,
    "createdAt": "2026-09-23T15:02:11Z",
    "createdByUserId": 812,
    "createdByEmail": "jane@example.com",
    "isRevert": true,
    "restoredFromVersionId": 812,
    "restoredFromVersionNumber": 1,
    "restoredFromCreatedAt": "2026-09-23T15:02:11Z",
    "prompts": [
      {
        "name": "string",
        "prompt": "string",
        "type": "system",
        "flow": "qualification",
        "order": 1,
        "toOutput": true,
        "toRewrite": 1
      }
    ]
  }
}
```

## Restore a prompt version

`POST /v1/segments/{segmentId}/prompt-versions/{versionId}/restore` - operationId `prompt-versions.restore`

| Permission | Rate limit |
| --- | --- |
| Campaigns edit | 4,800 requests a minute per API key |

Replaces all of the segment's prompts with the version's prompts, and puts back the model settings saved with
it. Kenso saves the result as a new version and returns its `versionNumber`. `versionWarning` is set
when the prompts were restored but Kenso could not fully save the new version or the model settings.

A restore can clear AI results Kenso already made for the campaign. Send `dryRun: true` to see what it would
clear without changing anything: `hasImpact` and `impact` describe it. Without `confirm: true`, a
restore that would clear results stops with `409 conflict` and `error.impact`. The body is optional.

Errors:

- `404 not_found`: the segment is not in this workspace, or the version is not one of its versions.
- `409 conflict`: the restore would clear AI results, so send `confirm: true` to go ahead. Or another
version save is running for the segment: try again shortly.

Requires Campaigns edit.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/prompt-versions/POST/v1/segments/%7BsegmentId%7D/prompt-versions/%7BversionId%7D/restore)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `segmentId` | path | integer (int64) | yes | The segment's id. |
| `versionId` | path | integer (int64) | yes | The id of the version to restore. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Request body

`application/json`, optional.

Optional: `confirm` and `dryRun`.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `confirm` | boolean | no | Set to true to restore even when the restore would clear AI output already generated for the campaign. Without it, such a restore answers `409 conflict` with `error.impact`. Defaults to false. |
| `dryRun` | boolean | no | Set to true to see what the restore would clear without changing anything. Defaults to false. |

### Response 200

`data` is a `PromptVersionRestore`.

| Field | Type | Description |
| --- | --- | --- |
| `dryRun` | boolean | True on a dry run: nothing was restored, and `impact` shows what a restore would clear. |
| `versionNumber` | integer (int32) | The number of the new version the restore saved. Null on a dry run. |
| `versionWarning` | string | Set when the prompts were restored but Kenso could not fully save the new version or the model settings. Null otherwise. |
| `hasImpact` | boolean | On a dry run, whether a restore would clear AI results. Null otherwise. |
| `impact` | InvalidationImpact | On a dry run, what a restore would clear. Null otherwise. |
| `message` | string | On a dry run, what a restore would do, in words. Null otherwise. |

### Request

```bash
curl -X POST "https://api.ken.so/v1/segments/812/prompt-versions/812/restore" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "confirm": true,
  "dryRun": true
}'
```

### Example response

```json
{
  "success": true,
  "data": {
    "dryRun": true,
    "versionNumber": 1,
    "versionWarning": "string",
    "hasImpact": true,
    "impact": {
      "qualificationResponses": 1,
      "qualifiedFlags": 1,
      "segmentationReasoning": 1,
      "segmentationAssignmentsKept": 1,
      "segmentationAssignmentsReset": 1,
      "personalizationLines": 1,
      "personalizationLeads": 1,
      "rewritingLines": 1,
      "rewritingLeads": 1
    },
    "message": "string"
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### PromptVersionPrompt

One prompt as a version saved it.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | no | The prompt's name. |
| `prompt` | string | no | The instructions the AI follows. |
| `type` | string | no | The message role the prompt is sent as: `system`, `user` or `assistant`. |
| `flow` | string | no | The step the prompt belongs to, such as `qualification` or `personalization`. |
| `order` | integer (int32) | no | Where the prompt sat among the segment's prompts. Lower numbers come first. |
| `toOutput` | boolean | no | On a personalization prompt, true when the AI writes the result as an AI variable. |
| `toRewrite` | integer (int32) | no | Above 0 when the rewriting step rewrites this AI variable. |

### InvalidationImpact

How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it keeps or resets.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `qualificationResponses` | integer (int32) | no | Stored qualification answers the change would clear. |
| `qualifiedFlags` | integer (int32) | no | Contacts whose qualified result the change would clear. |
| `segmentationReasoning` | integer (int32) | no | Stored segmentation explanations the change would clear. |
| `segmentationAssignmentsKept` | integer (int32) | no | Contacts that keep their segment. |
| `segmentationAssignmentsReset` | integer (int32) | no | Contacts that go back to the default segment. |
| `personalizationLines` | integer (int32) | no | Personalized lines the change would clear. |
| `personalizationLeads` | integer (int32) | no | Contacts that would lose their personalized lines. |
| `rewritingLines` | integer (int32) | no | Rewritten lines the change would clear. |
| `rewritingLeads` | integer (int32) | no | Contacts that would lose their rewritten lines. |

All resources: [/docs.md](/docs.md).
