Skip to content

Recover a conversation

GET
/api/intake/{conversation_id}/recover
curl --request GET \
--url https://example.com/api/intake/example/recover \
--header 'Authorization: Bearer <token>'

Returns the full recovery payload for a conversation: state, files, messages (last 50), progress info, and canvas_url if complete. Used to restore the chat UI after a page refresh or tab close.

conversation_id
required
Conversation Id
string

Successful Response

Media type application/json
RecoverResponse
object
conversation_id
required
Conversation Id
string
status
required
Status
string
stage_slug
required
Stage Slug
string
deal_name
Any of:
string
files
Files
object
key
additional properties
any
messages
Messages
Array<object>
default:
object
key
additional properties
any
created_at
Any of:
Created At
progress
Any of:
object
key
additional properties
any
canvas_url
Any of:
string
completed_at
Any of:
number
deal_type_hint
Any of:
string
files_summary
Any of:
string
suggested_deal_name
Any of:
string
error_message
Any of:
string
file_count
File Count
integer
0
progress_step
Progress Step
string
default: Unknown
archived
Archived
boolean
deal_name_extraction
Any of:
object
key
additional properties
any
Example
{
"files": {},
"messages": [],
"file_count": 0,
"progress_step": "Unknown",
"archived": false
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}