Skip to main content
API docs by Redocly

Talkit API (1.0.0)

This is the Open API specification for the Mobile Assistant API. It is generated from the codebase and is the source of truth for the API.

User

A User is a customer of Mobile Assistant, and is the primary entity in the system.

Fetch a User

Fetch details about a User

Authorizations:
plugin_installation_jwt
path Parameters
id
required
integer (id)

The ID of the User to fetch

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "string",
  • "last_name": "string"
}

Transcript

A Transcript is a text representation of an audio recording submitted by a User.

List Transcripts

Fetch Transcripts for the current User

Authorizations:
plugin_installation_jwt
query Parameters
limit
integer (limit)

The maximum number of Transcripts to return

after_id
integer (after_id)

The ID of the last Transcript from the previous page

Responses

Response samples

Content type
application/json
{
  • "has_more": true,
  • "total_count": 0,
  • "data": [
    ]
}

Fetch a Transcript

Fetch details about a Transcript

Authorizations:
plugin_installation_jwt
path Parameters
id
required
integer (id)

The ID of the Transcript to fetch

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "logo_uri": "string",
  • "permissions": { },
  • "disabled": true,
  • "published": true,
  • "user_id": 0,
  • "crm_integration_id": 0,
  • "created_on": "string",
  • "updated_on": "string"
}

Plugin

A Plugin is an integration that can be installed by a User, and is the method you'll use to integrate with Mobile Assistant.

List Plugins

List all Plugins for the current developer

Authorizations:
developer_key
query Parameters
limit
integer (limit)

The maximum number of Plugins to return

after_id
integer (after_id)

The ID of the last Plugin from the previous page

Responses

Response samples

Content type
application/json
{
  • "has_more": true,
  • "total_count": 0,
  • "data": [
    ]
}

Get a Plugin

Get a Plugin by ID

Authorizations:
developer_key
path Parameters
id
required
integer (id)

The ID of the Plugin

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "permissions": {
    },
  • "published": true,
  • "disabled": true,
  • "crm_integration_id": 0,
  • "logo_uri": "string",
  • "user_id": 0,
  • "created_on": "string",
  • "updated_on": "string"
}

Create a Plugin Secret Key

Create a Plugin Secret Key for the Plugin selected by ID

Authorizations:
developer_key
path Parameters
id
required
integer (id)

The ID of the Plugin

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "description": "string",
  • "value": "string",
  • "plugin_id": 0,
  • "created_on": "string",
  • "updated_on": "string"
}

Plugin Installation

A Plugin Installation is an instance of a Plugin that has been installed by a User, and permits you to access the User's data on their behalf.

List Plugin Installations for a Plugin

Lists Plugin Installations for the Plugin selected by ID

Authorizations:
developer_key
path Parameters
id
required
integer (id)

The ID of the Plugin

query Parameters
limit
integer (limit)

The maximum number of Plugin Installations to return

after_id
integer (after_id)

The ID of the last Plugin Installations from the previous page

Responses

Response samples

Content type
application/json
{
  • "has_more": true,
  • "total_count": 0,
  • "data": [
    ]
}

Plugin Webhook

A Webhook is an endpoint that can be used to trigger events when a Plugin Installation receives an event.

List Webhooks for a Plugin

Lists Webhooks for the Plugin selected by ID

Authorizations:
developer_key
path Parameters
id
required
integer (id)

The ID of the Plugin

query Parameters
limit
integer (limit)

The maximum number of Plugin Webhook to return

after_id
integer (after_id)

The ID of the last Plugin Webhooks from the previous page

Responses

Response samples

Content type
application/json
{
  • "has_more": true,
  • "total_count": 0,
  • "data": [
    ]
}