Chatling

App · 25 actions

Manage Chatling chatbots, contacts, conversations and knowledge sources, and chat with your knowledge base.

Actions

ActionWhat it does
Add FAQAdd FAQ.
Add textAdd text.
AI CreditsAI Credits.
Chat with Knowledge Base AIChat with Knowledge Base AI.
Create chatbotCreate chatbot.
Create contactCreate contact.
Delete contactDelete contact.
Delete conversationDelete conversation.
Delete data sourceDelete data source.
Get chatbotRetrieve chatbot.
Get contactRetrieve contact.
Get conversationRetrieve conversation.
List AI languagesList AI languages.
List AI modelsList AI models.
List chatbot templatesList chatbot templates.
List chatbotsList chatbots.
List contactsList contacts.
List conversation messagesList conversation messages.
List conversationsList conversations.
List data sourcesList data sources.
List membersList members.
List settingsList settings.
Resync data sourceResync data source.
Update chatbot settingsUpdate chatbot settings.
Update conversationUpdate conversation.

Add FAQ

Add FAQ.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
FaqsfaqslistRequired
Array of FAQs to add to the knowledge base.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "faqs_added": 1
    },
    "status": "example"
  }
}

Add text

Add text.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
TextstextslistRequired
Array of texts to add to the knowledge base.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "texts_added": 1
    },
    "status": "example"
  }
}

AI Credits

AI Credits.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "max": 1,
      "used": 1
    },
    "status": "example"
  }
}

Chat with Knowledge Base AI

Chat with Knowledge Base AI.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
MessagemessagetextRequired
The message to send to the AI.
AI modelai_model_idnumberRequired
The ID of the AI model to use for the response. To get a list of available AI models, use the [List AI models](https://docs.chatling.ai/api-reference/v2/ai-kb/list-ai-models.md) endpoint.
Conversation IDconversation_idtext
The ID of the conversation. This allows the AI to remember the context of the conversation.
Contact IDcontact_idtext
The ID of the contact to associate with the conversation.
Languagelanguage_idnumber
The ID of the language to use for the AI response. To get a list of available languages, use the [List languages](https://docs.chatling.ai/api-reference/v2/ai-kb/list-ai-languages.md) endpoint.
Temperaturetemperaturenumber
The temperature to be used by the AI. The temperature controls the randomness of the response. A lower temperature value, such as 0, will make the outputs more focused and deterministic, whereas a higher temperature, such as 1, will make the responses more diverse and unpredictable.
Instructionsinstructionslist
List of [instructions](https://docs.chatling.ai/chatbot/ai/instructions.md) to tailor the AI's response. It can be used to provide additional context to the AI, such as the desired tone or style of the response.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "conversation_id": "example",
      "response": "example",
      "sources": []
    },
    "status": "example"
  }
}

Create chatbot

Create chatbot.

Inputs

NamenametextRequired
The chatbot name.
Templatetemplate_idnumber
The ID of the chatbot template to use. You can get the list of available templates using the [List chatbot templates](https://docs.chatling.ai/api-reference/v2/chatbots/list-chatbot-templates.md) endpoint.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "version": "example",
      "visibility": "example"
    },
    "status": "example"
  }
}

Create contact

Create contact.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
PropertiespropertiesobjectRequired
At least one of the following properties is required.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "id": "example"
    },
    "status": "example"
  }
}

Delete contact

Delete contact.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Contact IDcontact_idtextRequired
The contact ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "status": "example"
  }
}

Delete conversation

Delete conversation.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Conversation IDconversation_idtextRequired
The conversation ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "status": "example"
  }
}

Delete data source

Delete data source.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Data source IDdata_source_idtextRequired
The data source ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "status": "example"
  }
}

Get chatbot

Retrieve chatbot.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "version": "example",
      "visibility": "example"
    },
    "status": "example"
  }
}

Get contact

Retrieve contact.

Inputs

Contact IDcontact_idtextRequired
The contact ID.
Chatbotchatbot_idtextRequired
The chatbot ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "company": "example",
      "created_at": "example",
      "email": "example",
      "id": "example",
      "job_title": "example",
      "name": "example",
      "phone": "example",
      "website": "example"
    },
    "status": "example"
  }
}

Get conversation

Retrieve conversation.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Conversation IDconversation_idtextRequired
The conversation ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "archived": 1,
      "contact_id": "example",
      "created_at": "example",
      "id": "example",
      "important": 1,
      "messages": []
    },
    "status": "example"
  }
}

List AI languages

List AI languages. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Pagepagenumber
The page number for pagination.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "languages": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List AI models

List AI models. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Pagepagenumber
The page number for pagination.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "models": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List chatbot templates

List chatbot templates. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
The page number for pagination.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      },
      "templates": []
    },
    "status": "example"
  }
}

List chatbots

List chatbots. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
The page number for pagination.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "chatbots": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List contacts

List contacts. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Pagepagenumber
The page number for pagination.
Sortsorttext
The sort order. Possible values:One of: date_desc (date desc), date_asc (date asc).

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "contacts": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List conversation messages

List conversation messages. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Conversation IDconversation_idtextRequired
The conversation ID.
Pagepagenumber
The page number for pagination.
Sortsorttext
The sort order. Possible values:One of: date_desc (date desc), date_asc (date asc).

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "messages": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List conversations

List conversations. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Cursorcursortext
The pagination cursor returned in pages.next_cursor from the previous response. Omit this parameter to retrieve the first page. Keep the same sort value when requesting subsequent pages.
Sortsorttext
The sort order. Possible values:One of: date_desc (date desc), date_asc (date asc).

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "conversations": [],
      "pages": {
        "has_more_pages": false,
        "next_cursor": "example",
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List data sources

List data sources. Gets one page; to see more, run it again with the next page it gives.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Pagepagenumber
The page number for pagination.
Sortsorttext
The sort order. Possible values:One of: date_desc (date desc), date_asc (date asc).
Typetypetext
Filter by the type of the data source. Possible values are link, text, faq, document, and zoho.One of: link, text, faq, document, zoho.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "pages": {
        "current_page": 1,
        "last_page": 1
      },
      "sources": []
    },
    "status": "example"
  }
}

List members

List members. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
The page number for pagination.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "members": [],
      "pages": {
        "current_page": 1,
        "last_page": 1,
        "per_page": 1
      }
    },
    "status": "example"
  }
}

List settings

List settings. Gets one page; to see more, run it again with the next page it gives.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "name": "example",
      "project_id": "example"
    },
    "status": "example"
  }
}

Resync data source

Resync data source.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Data source IDdata_source_idtextRequired
The data source ID.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "status": "example"
  }
}

Update chatbot settings

Update chatbot settings.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Namenametext
The chatbot name.
Visibilityvisibilitytext
The visibility of the chatbot. Possible values are public and private.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "created_at": "example",
      "id": "example",
      "name": "example",
      "version": "example",
      "visibility": "example"
    },
    "status": "example"
  }
}

Update conversation

Update conversation.

Inputs

Chatbotchatbot_idtextRequired
The chatbot ID.
Conversation IDconversation_idtextRequired
The conversation ID.
Archivearchivetrue/false
Whether to archive the conversation.
Importantimportanttrue/false
Whether to mark the conversation as important.
Contact IDcontact_idtext
The ID of the contact to associate with the conversation.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "data": {
      "archived": 1,
      "contact_id": "example",
      "created_at": "example",
      "id": "example",
      "important": 1,
      "messages": []
    },
    "status": "example"
  }
}

On this page