flow_conversations

list flow conversations

Changed on
get/w/{workspace}/flow_conversations/list

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/flow_conversations/list
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required

Query parameters

pageinteger

which page to return (start at 1, default 1)

per_pageinteger

number of items to return for a given page (default 30, max 100)

flow_pathstring

filter conversations by flow path

kind'test' | 'deployed' | 'all'

which conversations to list - the flow editor's test chats, the deployed flow's own (the default), or both

Response

flow conversations list

idstring uuid required

Unique identifier for the conversation

workspace_idstring required

The workspace ID where the conversation belongs

flow_pathstring required

Path of the flow this conversation is for

titlestring nullable

Optional title for the conversation

created_atstring date-time required

When the conversation was created

updated_atstring date-time required

When the conversation was last updated

created_bystring required

Username who created the conversation

is_testboolean required

Started from the flow editor's test panel rather than a deployed run

Changes

  • 74f899839f06Revision changes
    • info

      added the optional property / to the response with the status

  • 55fe5c67f11cRevision changes
    • info

      added the new optional query request parameter kind

    • info

      added the required property / to the response with the status