Create replay

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/replays/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "mode": "until",
    "mlModels": {
      "generateAnswer": "gpt-4.1"
    }
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/replays/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    json={
        "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
        "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
        "mode": "until",
        "mlModels": {"generateAnswer": "gpt-4.1"},
    },
)
replay = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/replays/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    interactionId: "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    eventId: "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    mode: "until",
    mlModels: { generateAnswer: "gpt-4.1" },
  }),
});
const replay = await response.json();

{
  "id": "9d4bbcf7-e7e1-44a6-9a64-ff0a12dfe625",
  "companyId": "6bc9f4f8-3564-4a9c-8cc0-ea1f1dd66c2d",
  "botId": "2a1cf0f0-f35d-46ad-8e61-a15c86b2b312",
  "source": "replay",
  "channel": "widget",
  "status": "resolved",
  "createdAt": "2026-07-30T12:18:03.211Z",
  "updatedAt": "2026-07-30T12:18:14.904Z",
  "parentInteractionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
  "replay": {
    "target_event_id": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "status": "done",
    "ml_models": {
      "generateAnswer": "gpt-4.1"
    }
  }
}

POST

replays

public

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/replays/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "mode": "until",
    "mlModels": {
      "generateAnswer": "gpt-4.1"
    }
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/replays/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    json={
        "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
        "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
        "mode": "until",
        "mlModels": {"generateAnswer": "gpt-4.1"},
    },
)
replay = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/replays/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    interactionId: "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    eventId: "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    mode: "until",
    mlModels: { generateAnswer: "gpt-4.1" },
  }),
});
const replay = await response.json();

{
  "id": "9d4bbcf7-e7e1-44a6-9a64-ff0a12dfe625",
  "companyId": "6bc9f4f8-3564-4a9c-8cc0-ea1f1dd66c2d",
  "botId": "2a1cf0f0-f35d-46ad-8e61-a15c86b2b312",
  "source": "replay",
  "channel": "widget",
  "status": "resolved",
  "createdAt": "2026-07-30T12:18:03.211Z",
  "updatedAt": "2026-07-30T12:18:14.904Z",
  "parentInteractionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
  "replay": {
    "target_event_id": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "status": "done",
    "ml_models": {
      "generateAnswer": "gpt-4.1"
    }
  }
}

Creates a replay conversation from an existing conversation and target Fini response event. The replay runs immediately, stores its result as a separate conversation, and returns the replay conversation.

This endpoint needs write scope. It creates a replay record, but it does not change the original conversation or publish any configuration changes.

Use List conversations or Get conversation to find the original conversation ID and the Fini response event ID.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs write scope.

string

required

Send application/json.

Body parameters

string

required

ID of the original conversation to replay.

string

required

ID of the Fini response event to replay. The response must have a linked user event in the same conversation.

enum

Replay mode. Use until to replay up to the selected response, or single to replay only that response. Defaults to until.

object

Optional model overrides for this replay run. Supported keys are performPlanning, searchKnowledge, generateAnswer, and tagSelection; each value must be a non-empty model name.

object

Optional answer-generation artifacts to inject into the replay. Use this only when you have validated artifact data from Fini’s conversation tooling.

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/replays/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "mode": "until",
    "mlModels": {
      "generateAnswer": "gpt-4.1"
    }
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/replays/public",
    headers={"Authorization": "Bearer fini_your_api_key"},
    json={
        "interactionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
        "eventId": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
        "mode": "until",
        "mlModels": {"generateAnswer": "gpt-4.1"},
    },
)
replay = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/replays/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    interactionId: "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
    eventId: "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    mode: "until",
    mlModels: { generateAnswer: "gpt-4.1" },
  }),
});
const replay = await response.json();

Response

Returns the replay conversation record.

string

Replay conversation ID.

string

Original conversation ID this replay was created from.

object

Replay metadata, including target_event_id, status, and optional ml_models.

{
  "id": "9d4bbcf7-e7e1-44a6-9a64-ff0a12dfe625",
  "companyId": "6bc9f4f8-3564-4a9c-8cc0-ea1f1dd66c2d",
  "botId": "2a1cf0f0-f35d-46ad-8e61-a15c86b2b312",
  "source": "replay",
  "channel": "widget",
  "status": "resolved",
  "createdAt": "2026-07-30T12:18:03.211Z",
  "updatedAt": "2026-07-30T12:18:14.904Z",
  "parentInteractionId": "0b8626b0-4cc8-4a3d-8fc2-f18ad1a4a1a8",
  "replay": {
    "target_event_id": "f61a9a11-2c3b-4704-8f57-7078854d87cf",
    "status": "done",
    "ml_models": {
      "generateAnswer": "gpt-4.1"
    }
  }
}

Errors

400 Bad Request

The body failed validation. interactionId and eventId must be UUIDs, mode must be until or single, and mlModels can only include supported operation keys with non-empty string values.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the write scope required for this route.

404 Not Found

The target event does not exist in the workspace, or the event does not belong to the supplied conversation.

500 Internal Server Error

The target event is not a Fini response, the response has no linked user event to replay, or the replay run failed.

⌘I

​Headers

​Body parameters

​Response

​Errors

Headers

Body parameters

Response

Errors