/api/metabot/conversations

POST /api/metabot/conversations/{id}/fork

Changed on

Fork a conversation at an assistant message, returning a brand-new conversation that copies the thread from the start up to and including that message.

Only the conversation's originator may fork it, for now. message_id is the external_id of the message to fork at, which must be a live, finished, non-errored assistant message. The clone gets fresh conversation/message ids, fresh timestamps, the current user as owner, and zeroed token usage so the fork does not double-count tokens in the analytics views.

post/api/metabot/conversations/{id}/fork

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

value must be a valid UUID.

Request body

message_idstring required

value must be a valid UUID.

Response

Successful response

context_window_tokensinteger
conversation_idstring required

value must be a valid UUID.

created_atstring date-time required

value must be a valid date/time/datetime

forked_from_conversation_idstring nullable required

value must be a valid UUID.

titlestring nullable required
user_idinteger nullable required

value must be an integer greater than zero.

Changes