# ChatKitty Platform API API

> ChatKitty Platform API API on Apizie: 67 endpoints (Export message analytics, Export user analytics, Retrieve the authenticated application, Retrieve the authenticated application settings, …) 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/communication:chatkitty/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:chatkitty`
- Category: Communication
- Status: byok
- Source: https://chatkitty.com
- Page: https://zieapi.vercel.app/api/communication/chatkitty
- OpenAPI: https://zieapi.vercel.app/api/communication/chatkitty/openapi.json

OpenAPI specification (OAS) for the ChatKitty Platform API. See the Interactive Docs to try ChatKitty API methods without writing code, and get the complete schema of resources exposed by the API.

## Endpoints

### Export message analytics
`POST https://zieapi.vercel.app/v1/communication:chatkitty/analytics-export-message-analytics-data` (byok)

### Export user analytics
`POST https://zieapi.vercel.app/v1/communication:chatkitty/analytics-export-user-analytics-data` (byok)

### Retrieve the authenticated application
`GET https://zieapi.vercel.app/v1/communication:chatkitty/application-get-authenticated` (byok)

### Retrieve the authenticated application settings
`GET https://zieapi.vercel.app/v1/communication:chatkitty/application-get-settings` (byok)

### Update the authenticated application settings
`POST https://zieapi.vercel.app/v1/communication:chatkitty/application-update-settings` (byok)

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

### List channels
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |
| type | string | no | Filters by channel type |
| members | array | no | Filters by channel members using their usernames |
| startTime | string | no | Filters for channels created within a time range: start time |
| endTime | string | no | Filters for channels created within a time range: end time |
| properties | string | no | Filters by channel custom properties |

### Create a channel
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-create-channel` (byok)

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

### Retrieve a channel
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |

### Update a channel
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-update-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | no | JSON request body |

### Delete a channel
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |

### Send a channel event
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-send-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | yes | JSON request body |

### List channel invites
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-invites` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Send a channel invite
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-send-invite` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | yes | JSON request body |

### Send channel keystrokes
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-send-keystrokes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| body | object | yes | JSON request body |

### List a channel's members
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-members-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Add a channel member
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-add-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | yes | JSON request body |

### Remove a channel member
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-remove-member` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| user_id | integer | yes | User ID of member to be removed |

### List channel memberships
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-memberships-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### List channel messages
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-messages-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| size | integer | no | The size of the page to be returned |
| start | integer | no | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| next | integer | no | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages |
| relation | string | no | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| username | string | no |  |
| query | string | no |  |

### Send a channel message
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-send-channel-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | yes | JSON request body |

### Lists a channel's moderators
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-moderators-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Add a channel moderator
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-add-moderator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| body | object | yes | JSON request body |

### Remove a channel moderator
`POST https://zieapi.vercel.app/v1/communication:chatkitty/channels-remove-moderator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| user_id | integer | yes | User ID of moderator to be removed |

### List channel participants
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-participants-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### List channel reported messages
`GET https://zieapi.vercel.app/v1/communication:chatkitty/channels-list-reported-messages-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Channel ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### List chat sessions
`GET https://zieapi.vercel.app/v1/communication:chatkitty/chatsessions-list-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |
| state | string | no | Filters by state |

### Retrieve a chat function version
`GET https://zieapi.vercel.app/v1/communication:chatkitty/functionversions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function version ID |

### Retrieve a chat function
`GET https://zieapi.vercel.app/v1/communication:chatkitty/functions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function ID |

### Retrieve chat function current version
`GET https://zieapi.vercel.app/v1/communication:chatkitty/functions-get-current-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function ID |

### List chat function invocations
`GET https://zieapi.vercel.app/v1/communication:chatkitty/functions-list-invocations-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### List chat function versions
`GET https://zieapi.vercel.app/v1/communication:chatkitty/functions-list-versions-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Create a chat function version
`POST https://zieapi.vercel.app/v1/communication:chatkitty/functions-create-function-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Chat function ID |
| body | object | yes | JSON request body |

### Import channels
`POST https://zieapi.vercel.app/v1/communication:chatkitty/imports-batch-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Import channel members
`POST https://zieapi.vercel.app/v1/communication:chatkitty/imports-channel-members-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| body | object | no | Form fields as a JSON object |

### Import messages
`POST https://zieapi.vercel.app/v1/communication:chatkitty/imports-batch-messages-from-json` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Import users
`POST https://zieapi.vercel.app/v1/communication:chatkitty/imports-json-users-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### List jobs
`GET https://zieapi.vercel.app/v1/communication:chatkitty/jobs-list-jobs-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |
| running | boolean | no | Filters for jobs currently running |

### Retrieve a job
`GET https://zieapi.vercel.app/v1/communication:chatkitty/jobs-get-job-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Job ID |

### List messages
`GET https://zieapi.vercel.app/v1/communication:chatkitty/messages-list-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| size | integer | no | The size of the page to be returned |
| start | integer | no | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| next | integer | no | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages |
| relation | string | no | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| username | string | no | Filters messages by a sender's username |
| query | string | no | Filters text messages by text contained in the message body |

### Delete messages
`POST https://zieapi.vercel.app/v1/communication:chatkitty/messages-delete-all` (byok)

### Retrieve a message
`GET https://zieapi.vercel.app/v1/communication:chatkitty/messages-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Message ID |

### Update a message
`POST https://zieapi.vercel.app/v1/communication:chatkitty/messages-update-properties` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Message ID |
| body | object | no | JSON request body |

### Delete a message
`POST https://zieapi.vercel.app/v1/communication:chatkitty/messages-remove-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Message ID |

### List message read receipts
`GET https://zieapi.vercel.app/v1/communication:chatkitty/messages-list-read-receipts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Retrieve NodeJS chat runtime
`GET https://zieapi.vercel.app/v1/communication:chatkitty/runtime-get-nodejs-chat-runtime` (byok)

### Update NodeJS chat runtime NPM dependencies
`POST https://zieapi.vercel.app/v1/communication:chatkitty/runtime-update-nodejs-chat-dependencies` (byok)

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

### Update NodeJS chat runtime environment variables
`POST https://zieapi.vercel.app/v1/communication:chatkitty/runtime-update-nodejs-chat-environment-variables` (byok)

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

### List NodeJS chat runtime functions
`GET https://zieapi.vercel.app/v1/communication:chatkitty/runtime-list-nodejs-chat-functions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Create a NodeJS chat runtime function
`POST https://zieapi.vercel.app/v1/communication:chatkitty/runtime-create-nodejs-chat-function` (byok)

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

### Update NodeJS chat runtime initialization script
`POST https://zieapi.vercel.app/v1/communication:chatkitty/runtime-update-nodejs-chat-initialization-script` (byok)

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

### Retrieve a thread
`GET https://zieapi.vercel.app/v1/communication:chatkitty/threads-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Reply thread ID |

### Send thread keystrokes
`POST https://zieapi.vercel.app/v1/communication:chatkitty/threads-send-keystrokes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| body | object | yes | JSON request body |

### List reply thread messages
`GET https://zieapi.vercel.app/v1/communication:chatkitty/threads-list-thread-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| size | integer | no | The size of the page to be returned |
| start | integer | no | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| next | integer | no | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages |
| relation | string | no | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |

### Send a reply thread message
`POST https://zieapi.vercel.app/v1/communication:chatkitty/threads-send-reply-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes |  |
| body | object | yes | JSON request body |

### List user sessions
`GET https://zieapi.vercel.app/v1/communication:chatkitty/usersessions-list-user-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |
| state | string | no | Filters by state |

### List users
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-get-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |
| name | string | no | Filters by username |
| properties | string | no | Filters by user custom properties |

### Create a user
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-create-user` (byok)

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

### Retrieve a user
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |

### Update a user
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-update-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| body | object | no | JSON request body |

### Delete a user
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-remove-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |

### List a user's channels
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-list-channels-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| page | integer | no | Zero-based page index (0..N) |
| size | integer | no | The size of the page to be returned |
| sort | array | no | Sorting criteria in the format: property,(asc/desc). Default sort order is ascending. Multiple sort criteria are supported. |

### Update a user's display picture
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-update-display-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| body | object | yes | JSON request body |

### List a user's messages
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-list-messages-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| size | integer | no | The size of the page to be returned |
| start | integer | no | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| next | integer | no | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages |
| relation | string | no | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| unread | boolean | no | Filters by returning unread messages |

### List a user's notifications
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-list-notifications-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| size | integer | no | The size of the page to be returned |
| start | integer | no | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |
| next | integer | no | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages |
| relation | string | no | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages |

### Retrieve a user secret
`GET https://zieapi.vercel.app/v1/communication:chatkitty/users-get-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| name | string | yes | The secret's name |

### Set a user secret
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-set-user-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| name | string | yes | The secret's name |
| body | object | yes | JSON request body |

### Remove a user secret
`POST https://zieapi.vercel.app/v1/communication:chatkitty/users-remove-secret-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | User ID |
| name | string | yes | The secret's name |

## Example
```
curl "https://zieapi.vercel.app/v1/communication:chatkitty/analytics-export-message-analytics-data" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the ChatKitty Platform API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/communication:chatkitty/analytics-export-message-analytics-data with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the ChatKitty Platform 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 communication:chatkitty.

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