# Conversation API API

> Conversation API API on Apizie: 19 endpoints (Create a conversation, Retrieve a conversation, Update a conversation, Delete a conversation, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:nexmo-conversation/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:nexmo-conversation`
- Category: Open Data
- Status: byok
- Source: https://developer.nexmo.com/
- Page: https://zieapi.vercel.app/api/open-data/nexmo-conversation
- OpenAPI: https://zieapi.vercel.app/api/open-data/nexmo-conversation/openapi.json

The Conversation API enables you to build conversation features where communication can take place across multiple mediums including IP Messaging, PSTN Voice, SMS and WebRTC Audio and Video. The context of the…

## Endpoints

### Create a conversation
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a conversation
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/retrieve-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |

### Update a conversation
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/replace-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| body | object | no | JSON request body |

### Delete a conversation
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/delete-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |

### Create an event
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| body | object | no | JSON request body |

### Retrieve an event
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/get-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| event_id | string | yes | Event ID |

### Delete an event
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/delete-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| event_id | string | yes | Event ID |

### Create a member
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| body | object | no | JSON request body |

### Retrieve a member
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/get-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| member_id | string | yes | Member ID |

### Update a member
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/update-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| member_id | string | yes | Member ID |
| body | object | no | JSON request body |

### Delete a member
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/delete-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| member_id | string | yes | Member ID |

### Record a conversation
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/record-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversation_id | string | yes | Conversation ID |
| body | object | no | JSON request body |

### List legs
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/list-legs` (byok)

### Delete a leg
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/delete-leg` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| leg_id | string | yes | Leg ID |

### Create a user
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Retrieve a user
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | User ID |

### Update a user
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | User ID |
| body | object | no | JSON request body |

### Delete a user
`POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | User ID |

### List user conversations
`GET https://zieapi.vercel.app/v1/open-data:nexmo-conversation/getuser-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | yes | User ID |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-conversation" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Conversation API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/open-data:nexmo-conversation/create-conversation with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Conversation API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Conversation API itself also needs your own key from nexmo.com.

### Can AI agents use the Conversation API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:nexmo-conversation.

### What is the status of the Conversation API API?
Needs your own provider key (bring your own key)