Tutorials
  • Tutorials
  • Set up your Agent
    • Set Up Your Agent Step by Step.
    • Create your Knowledge Base Step by Step.
    • Connect your RSS or Newsletter
  • Writing Clear and Effective Instructions
  • Integrations
    • Web
    • WhatsApp
    • Email
    • Telegram
    • Wordpress
    • Framer
    • API
    • Shopify
    • Slack
    • Webhook
    • Google Chat
  • Campaings
    • WhatsApp Campaigns
  • Alerts
    • Create an Alert
  • Tools
    • Create a Tool
  • Widgets
    • Web Widgets Documentation
  • Human Intervetion
    • How it works?
  • faq
    • How do I make my subscription payment and manage my invoices?
Powered by GitBook
On this page
  • Accessing to more advanced documentation
  • 1. Get an API Key
  • 2. Access Postman
  • 3. Authorize your API
  • 4. Configure and send a request
  • 4.1 Get the Chat ID
  1. Integrations

API

How to use our API.

PreviousFramerNextShopify

Last updated 10 months ago

Also you can check the status of the systems

Accessing to more advanced documentation

You can access to all the API documentation.

1. Get an API Key

The first thing you need to do is to get an API Key. To do this go to Advanced Integrations and click on configuration in API in the Caleida Dasboard.

Once here give it a name and copy it or write it down in a safe place. You will not be able to see this key again in full from the Caleida website.

2. Access Postman

Once inside click on send an API request.

3. Authorize your API

Under "Enter URL or paste text", click on "Authorization" and in the drop down menu select "API Key".

Now we will fill in the fields:

  • Key: API Name (use the same one you gave in Caleida).

  • Value: Paste the API Key you copied from the Caleida website.

  • Add to: Make sure you add it to "Header".

4. Configure and send a request

4.1 Get the Chat ID

Once you have pasted the URL click on "Send".

Through the following you can access Postman. Create an account or login if you already have one.

Once the API is authorized, we will configure the request. Make sure it is a "GET" request and enter the link (where {chat_id} represents the ID of the chat you wish to access).

For example, if your chat ID is 12345, the URL would be

link
https://core.api.caleida.io/chats/records/{chat_id}/
https://core.api.caleida.io/chats/records/12345/
here
here