# Conversations ## List Conversations > List conversations with pagination and filtering ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations":{"get":{"summary":"List Conversations","deprecated":false,"description":"List conversations with pagination and filtering","operationId":"list_conversations_admin_api_v2_conversations_get","tags":["Conversations"],"parameters":[{"name":"assignment_id","in":"query","description":"Filter by assignment ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by assignment ID","title":"Assignment Id"}},{"name":"agent_id","in":"query","description":"Filter by agent ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by agent ID","title":"Agent Id"}},{"name":"page_num","in":"query","description":"Current page number","required":false,"schema":{"type":"integer","description":"Current page number","default":1,"title":"Page Num"}},{"name":"page_size","in":"query","description":"Items per page","required":false,"schema":{"type":"integer","description":"Items per page","default":20,"title":"Page Size"}},{"name":"order","in":"query","description":"order by: 'recent'(default) or 'oldest'","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"order by: 'recent'(default) or 'oldest'","default":"recent","title":"Order"}},{"name":"status","in":"query","description":"Filter by status","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status","title":"Status"}},{"name":"statuses","in":"query","description":"Filter by statuses","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by statuses","title":"Statuses"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationsResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"ListConversationsResponse":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"Current page number"},"page_size":{"type":"integer","title":"Page Size","description":"Number of items per page"},"total_count":{"type":"integer","title":"Total Count","description":"Total number of items"},"total_pages":{"type":"integer","title":"Total Pages","description":"Total number of pages","default":1},"has_next_page":{"type":"boolean","title":"Has Next Page","description":"Whether there is a next page"},"data":{"items":{"$ref":"#/components/schemas/GetConversationResponse"},"type":"array","title":"Data","description":"List of conversations"}},"type":"object","required":["page_num","page_size","total_count","has_next_page","data"],"title":"ListConversationsResponse"},"GetConversationResponse":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Conversation ID"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic","description":"Conversation topic"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Agent mode"},"extend_properties":{"type":"object","title":"Extend Properties","description":"Extended properties","properties":{}},"invoke_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoke From","description":"Invoke from"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Workforce run status","default":"running"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time","description":"Created time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time","description":"Updated time"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Created by name"},"updated_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Name","description":"Updated by name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type","description":"Agent type"},"message_count":{"type":"integer","title":"Message Count","description":"Message count"}},"type":"object","required":["id","agent_id","tenant_id","tenant_unit_id","user_id","agent_mode","message_count"],"title":"GetConversationResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## List Messages By Conversation > List messages in a conversation with pagination ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations/{conversation_id}/messages":{"get":{"summary":"List Messages By Conversation","deprecated":false,"description":"List messages in a conversation with pagination","operationId":"list_messages_by_conversation_admin_api_v2_conversations__conversation_id__messages_get","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Conversation Id"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","description":"Page number","default":1,"title":"Page"}},{"name":"page_size","in":"query","description":"Page size","required":false,"schema":{"type":"integer","description":"Page size","default":20,"title":"Page Size"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMessagesResponse"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"ListMessagesResponse":{"properties":{"page_num":{"type":"integer","title":"Page Num","description":"Current page number"},"page_size":{"type":"integer","title":"Page Size","description":"Number of items per page"},"total_count":{"type":"integer","title":"Total Count","description":"Total number of items"},"total_pages":{"type":"integer","title":"Total Pages","description":"Total number of pages","default":1},"has_next_page":{"type":"boolean","title":"Has Next Page","description":"Whether there is a next page"},"data":{"items":{"$ref":"#/components/schemas/MessageSchema"},"type":"array","title":"Data","description":"List of messages"}},"type":"object","required":["page_num","page_size","total_count","has_next_page","data"],"title":"ListMessagesResponse"},"MessageSchema":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Message ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"conversation_id":{"type":"string","title":"Conversation Id","description":"Conversation ID"},"run_id":{"type":"string","title":"Run Id","description":"Run ID"},"message_from":{"type":"string","title":"Message From","description":"Message from"},"content":{"type":"string","title":"Content","description":"Content"},"requested_time":{"type":"string","format":"date-time","title":"Requested Time","description":"Requested time"},"input_tokens":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Input Tokens","description":"Input tokens","default":0},"answer_tokens":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Answer Tokens","description":"Answer tokens","default":0},"total_tokens":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Total Tokens","description":"Total tokens","default":0},"feedback":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedback","description":"Feedback"},"metadata":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Metadata","description":"Meta data"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Type"},"user_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Type","description":"User type"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status"},"event_trace":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Trace","description":"Event trace"}},"type":"object","required":["id","tenant_id","tenant_unit_id","agent_id","user_id","conversation_id","run_id","message_from","content","requested_time"],"title":"MessageSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## Create Conversation > Create a new conversation ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations":{"post":{"summary":"Create Conversation","deprecated":false,"description":"Create a new conversation","operationId":"create_conversation_admin_api_v2_conversations_post","tags":["Conversations"],"parameters":[{"name":"assignment_id","in":"query","description":"Filter by assignment ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by assignment ID","title":"Assignment Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationCreateRequest","description":"Conversation create request"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationSchema"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"ConversationCreateRequest":{"properties":{"topic":{"type":"string","title":"Topic","description":"Conversation topic","default":"New Conversation"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Conversation status","default":"running"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id","description":"Agent ID"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"}},"type":"object","title":"ConversationCreateRequest"},"ConversationSchema":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Conversation ID"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic","description":"Conversation topic"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Agent mode"},"extend_properties":{"type":"object","title":"Extend Properties","description":"Extended properties","properties":{}},"invoke_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoke From","description":"Invoke from"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Workforce run status","default":"running"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time","description":"Created time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time","description":"Updated time"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Created by name"},"updated_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Name","description":"Updated by name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type","description":"Agent type"}},"type":"object","required":["id","agent_id","tenant_id","tenant_unit_id","user_id","agent_mode"],"title":"ConversationSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## Update Conversation > Update a conversation (currently only supports updating topic) ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations/{conversation_id}":{"patch":{"summary":"Update Conversation","deprecated":false,"description":"Update a conversation (currently only supports updating topic)","operationId":"update_conversation_admin_api_v2_conversations__conversation_id__patch","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Conversation Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Update Data","properties":{}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationSchema"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"ConversationSchema":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Conversation ID"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic","description":"Conversation topic"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Agent mode"},"extend_properties":{"type":"object","title":"Extend Properties","description":"Extended properties","properties":{}},"invoke_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoke From","description":"Invoke from"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Workforce run status","default":"running"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time","description":"Created time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time","description":"Updated time"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Created by name"},"updated_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Name","description":"Updated by name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type","description":"Agent type"}},"type":"object","required":["id","agent_id","tenant_id","tenant_unit_id","user_id","agent_mode"],"title":"ConversationSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## Get Conversation > Get a conversation by ID ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations/{conversation_id}":{"get":{"summary":"Get Conversation","deprecated":false,"description":"Get a conversation by ID","operationId":"get_conversation_admin_api_v2_conversations__conversation_id__get","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Conversation Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationSchema"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"ConversationSchema":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Conversation ID"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic","description":"Conversation topic"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Agent mode"},"extend_properties":{"type":"object","title":"Extend Properties","description":"Extended properties","properties":{}},"invoke_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoke From","description":"Invoke from"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Workforce run status","default":"running"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time","description":"Created time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time","description":"Updated time"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Created by name"},"updated_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Name","description":"Updated by name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type","description":"Agent type"}},"type":"object","required":["id","agent_id","tenant_id","tenant_unit_id","user_id","agent_mode"],"title":"ConversationSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## Delete Conversation > Delete a conversation and its messages ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations/{conversation_id}":{"delete":{"summary":"Delete Conversation","deprecated":false,"description":"Delete a conversation and its messages","operationId":"delete_conversation_admin_api_v2_conversations__conversation_id__delete","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Conversation Id"}}],"responses":{"204":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` ## Update Conversation Status > Update conversation status ```json {"openapi":"3.0.1","info":{"title":"workfx","version":"1.0.0"},"tags":[{"name":"Conversations"}],"servers":[{"url":"https://api.workfx.ai","description":"Prod Env"}],"security":[],"paths":{"/admin/api/v2/conversations/{conversation_id}/status":{"patch":{"summary":"Update Conversation Status","deprecated":false,"description":"Update conversation status","operationId":"update_conversation_status_admin_api_v2_conversations__conversation_id__status_patch","tags":["Conversations"],"parameters":[{"name":"conversation_id","in":"path","description":"","required":true,"schema":{"type":"string","title":"Conversation Id"}},{"name":"tenant_id","in":"query","description":"Tenant Id","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Id","title":"Tenant Id"}},{"name":"tenant_unit_id","in":"query","description":"Tenant Unit ID","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Tenant Unit ID","title":"Tenant Unit Id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationStatusRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationSchema"}}},"headers":{}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"headers":{}}}}}},"components":{"schemas":{"UpdateConversationStatusRequest":{"properties":{"status":{"anyOf":[{"$ref":"#/components/schemas/WorkforceRunStatus"},{"type":"null"}]}},"type":"object","title":"UpdateConversationStatusRequest"},"WorkforceRunStatus":{"type":"string","enum":["submitted","running","succeeded","failed","stopped","canceled","input-required","partial-succeeded","review-requested","reviewed","unknown"],"title":"WorkforceRunStatus","description":"Workforce Run Status Enum"},"ConversationSchema":{"properties":{"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"updated_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By"},"created_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Role"},"updated_by_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Role"},"id":{"type":"string","title":"Id","description":"Conversation ID"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Topic","description":"Conversation topic"},"agent_id":{"type":"string","title":"Agent Id","description":"Agent ID"},"tenant_id":{"type":"string","title":"Tenant Id","description":"Tenant ID"},"tenant_unit_id":{"type":"string","title":"Tenant Unit Id","description":"Tenant Unit ID"},"user_id":{"type":"string","title":"User Id","description":"User ID"},"agent_mode":{"type":"string","title":"Agent Mode","description":"Agent mode"},"extend_properties":{"type":"object","title":"Extend Properties","description":"Extended properties","properties":{}},"invoke_from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoke From","description":"Invoke from"},"inputs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Inputs","description":"Inputs"},"status":{"anyOf":[{"type":"object","properties":{}},{"type":"null"}],"description":"Workforce run status","default":"running"},"assignment_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Assignment Id","description":"Assignment ID"},"created_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Time","description":"Created time"},"updated_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Time","description":"Updated time"},"created_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By Name","description":"Created by name"},"updated_by_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated By Name","description":"Updated by name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type","description":"Agent type"}},"type":"object","required":["id","agent_id","tenant_id","tenant_unit_id","user_id","agent_mode"],"title":"ConversationSchema"},"HTTPValidationError":{"properties":{"detail":{"items":{"type":"object","properties":{}},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.workfx.ai/workfx-1.1.x-english/developer-docs/api-reference/conversations.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.