Unipile: Sync Chat History

Starts (or polls the status of) a full-history synchronization of one chat from its beginning.

Tool ID: unipile_sync_chat_history

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_sync_chat_history',
  {
    "chat_id": "chat_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_sync_chat_history --input '{
  "chat_id": "chat_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "object": "ChatHistorySync",
    "chat_id": "chat_123",
    "status": "SYNC_STARTED"
  }
}

Use deepline describe unipile_sync_chat_history --json for the latest machine-readable contract.

Input reference

This route can be used both to initiate a synchronization process and to monitor its status via regular polling.

Name	Type	Required	Default	Details
`payload.account_id`	`string`	No	—	The account ID. Mandatory when chat_id is a provider ID.
`payload.chat_id`	`string`	Yes	—	The Unipile or provider ID of the chat to be synced.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.object`	`"ChatHistorySync"`	Yes	—	Allowed: `ChatHistorySync`.
`result.data.chat_id`	`string`	Yes	—	A unique identifier. Minimum length: 1.
`result.data.status`	`"SYNC_STARTED" \| "CHAT_DELETED" \| "SYNC_RUNNING" \| "SYNC_DONE" \| "SYNC_ERROR"`	Yes	—	The status of the chat synchronization. You can setup a regular polling on the same route to get updates on its status. A new request after a SYNC_DONE or SYNC_ERROR response will start a fresh sync. Allowed: `SYNC_STARTED`, `CHAT_DELETED`, `SYNC_RUNNING`, `SYNC_DONE`, `SYNC_ERROR`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation