# Synthflow

> Read agents and calls, manage contacts and memory stores, and inspect actions and chats.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/synthflow

## Actions

### Create contact

Create contact.

**Inputs**

- Name (`name`, text, required): The contact's name.
- Phone number (`phone_number`, text, required): The contact's phone number.
- Email (`email`, text): The contact's email address.
- Contact metadata (`contact_metadata`, object): Additional metadata for the contact.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "id": "example"
    },
    "status": "example"
  }
}
```

### Create memory store

Create memory store.

**Inputs**

- Title (`title`, text): Memory store name.
- Description (`description`, text): Memory store description.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "created_at": "example",
      "description": "example",
      "id": "example",
      "number_of_agents": 1,
      "number_of_contacts": 1,
      "title": "example",
      "updated_at": "example",
      "workspace_id": "example"
    },
    "status": "example"
  }
}
```

### Delete contact

Delete contact.

**Inputs**

- Contact ID (`contact_id`, text, required): Contact ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "status": "example"
  }
}
```

### Delete memory store

Delete memory store.

**Inputs**

- Memory store ID (`memory_store_id`, text, required): The ID of the memory store (group).

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "status": "example"
  }
}
```

### Get action

Get action.

**Inputs**

- Action (`action_id`, text, required): To find an action's ID, go to its page in your Synthflow dashboard.
- Include assistants (`include_assistants`, true/false): Include assistant IDs assigned to this action.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "actions": []
    },
    "status": "example"
  }
}
```

### Get agent

Get agent.

**Inputs**

- Model (`model_id`, text, required): Agent ID. You can find it on the agent’s page in your dashboard.
- Include actions (`include_actions`, true/false): Include action IDs and `input_variables` (each with the action's `trigger_condition`, `attachment_type`, and `input_variables_mapping`) grouped by `action_id`.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "assistants": [],
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### Get batch call

Get batch call.

**Inputs**

- Batch call (`batch_call_id`, text, required): The batch returned by `POST /calls/batch`, a UUID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "agent_name": "example",
      "batch_call_id": "example",
      "created_at": "example",
      "dispatched_count": 1,
      "failed_count": 1,
      "from_phone_number": "example",
      "model_id": "example",
      "name": "example",
      "pending_count": 1,
      "status": "example",
      "total_task_count": 1
    },
    "status": "example"
  }
}
```

### Get call

Get call.

**Inputs**

- Call ID (`call_id`, text, required): Call ID. You can find it on the logs page in your dashboard.
- Include all actions (`include_all_actions`, true/false): Include all_executed_actions in the response.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "calls": [],
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### Get chat

Get chat.

**Inputs**

- Chat (`chat_id`, text, required): Chat ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "chat_id": "example",
      "chat_status": "ongoing",
      "conversation_history": [],
      "fsm_log": {},
      "initial_message": {
        "agent_message": "example",
        "current_state": "example",
        "timestamp": "example",
        "turn_number": 1
      },
      "start_timestamp": "example",
      "transcript": "example"
    },
    "status": "example"
  }
}
```

### Get contact

Get contact.

**Inputs**

- Contact ID (`contact_id`, text, required): Contact ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "contact_metadata": {
        "company": "example"
      },
      "created_at": "example",
      "email": "example",
      "id": "example",
      "memory_store_ids": [],
      "name": "example",
      "phone_number": "example",
      "updated_at": "example",
      "workspace_id": "example"
    },
    "status": "example"
  }
}
```

### Get memory store

Get memory store.

**Inputs**

- Memory store ID (`memory_store_id`, text, required): The memory store's ID.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "contact_ids": [],
      "created_at": "example",
      "id": "example",
      "title": "example",
      "updated_at": "example",
      "workspace_id": "example"
    },
    "status": "example"
  }
}
```

### List actions

List actions.

**Inputs**

- Limit (`limit`, number): Actions displayed per page.
- Offset (`offset`, number): Index of the first action to be returned.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "actions": [],
      "next_offset": 1,
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### List agents

List agents.

**Inputs**

- Limit (`limit`, number): Agents displayed per page.
- Offset (`offset`, number): Index of the first agent to be returned.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "assistants": [],
      "next_offset": 1,
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### List batch calls

List batch calls.

**Inputs**

- Limit (`limit`, number): Number of batches per page, between 1 and 100.
- Offset (`offset`, number): Number of batches to skip.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "batch_calls": [],
      "next_offset": 1,
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### List calls

List calls.

**Inputs**

- Model (`model_id`, text, required): The calls for the specified model ID will be returned
- Limit (`limit`, number): How many calls will be displayed in every page, default is 20
- Offset (`offset`, number): Index of the first call to be returned.
- From date (`from_date`, date and time): Begin timestamp (milliseconds since epoch) of the call. Available after the call starts. Example: 1732546200000
- To date (`to_date`, date and time): End timestamp (milliseconds since epoch) of the call. Available after the call ends. Example: 1732546200000
- Call status (`call_status`, text): Status of call.
- Duration min (`duration_min`, number): Only retrieve calls with duration greater than or equal to this value (seconds).
- Duration max (`duration_max`, number): Only retrieve calls with duration less than or equal to this value (seconds).
- Lead phone number (`lead_phone_number`, text): Phone number of the caller or callee (E.164 format preferred) and URL-encode the leading "+" (e.g. %2B14155552671)
- Action (`action_id`, text): Only retrieve calls that executed this action. Calls made before May 20, 2026 can't be filtered by action.
- Include all actions (`include_all_actions`, true/false): Include all_executed_actions in the response.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "calls": [],
      "next_offset": 1,
      "pagination": {
        "limit": 1,
        "offset": 1,
        "total_records": 1
      }
    },
    "status": "example"
  }
}
```

### List chats

List chats.

**Inputs**

- Agent (`agent_id`, text): Filter chats by agent ID.
- Limit (`limit`, number): Limit the number of chats to return.
- Cursor (`cursor`, text): Cursor to start from.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "chats": [],
      "has_more": false,
      "next_cursor": "example"
    },
    "status": "example"
  }
}
```

### List contacts

List contacts.

**Inputs**

- Search (`search`, text): The contact's phone number.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "items": [],
      "page_number": 1,
      "page_size": 1,
      "total": 1
    },
    "status": "example"
  }
}
```

### List memory stores

List memory stores.

**Inputs**

- Search (`search`, text): The memory store's title.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "response": {
      "items": [],
      "page_number": 1,
      "page_size": 1,
      "total": 1
    },
    "status": "example"
  }
}
```

### Update contact

Update contact.

**Inputs**

- Contact ID (`contact_id`, text, required): The contact's ID.
- Name (`name`, text): The contact's name.
- Phone number (`phone_number`, text): The contact's phone number.
- Email (`email`, text): The contact's email.
- Contact metadata (`contact_metadata`, object): Contact metadata.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "status": "example"
  }
}
```

### Update memory store

Update memory store.

**Inputs**

- Memory store ID (`memory_store_id`, text, required): The ID of the memory store (group).
- Title (`title`, text): Memory store name.
- Description (`description`, text): Memory store description.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "id": "example"
  }
}
```
