NewLead AI
  • 🏠Get Started
  • 💻App - app.newlead.ai
    • 📈Dashboard
    • 🤖My Bots
    • 👼Leads
  • 🚀API - api.newlead.ai
    • 🔐Authentication
    • 🤖Bots
    • 🔌Link bot to channel
    • 👼Leads
    • 🗣️Messages
    • 🔗Webhooks
    • ⚡Give it a try!
  • ❓FAQ
Powered by GitBook
On this page
  • POST Bot/Create
  • POST Bot/Update
  • GET Bot/Get
  • GET Bot/Get/{botId}
  • GET Bot/Get/{botId}/links
  • POST Bot/Disconnect/{botId}
  • POST Bot/Skill/Add
  • GET Bot/Get/{botId}/skills
  • POST Bot/Skill/Remove
  1. API - api.newlead.ai

Bots

POST Bot/Create

{
  "name": "string",
  "instructions": "string",
  "voiceId": "string",
  "followUpInstructions": "string",
  "manual": "bool",
  "randomAudios": "bool"
}

//Returns the ID of the newly created bot
  • Name: Name of the bot.

  • Instructions: Text to describe the behaviour of the bot.

  • VoiceId: Id of the voice for the bot to use. How do I find it? You can leave it empty to disable sending voice messages.

  • FollowUpInstructions: The bot will attempt to reactivate the conversation if it has been inactive for 20 hours. Leave empty to disable this feature.

  • Manual: False for the bot to reply automatically. True for manual conversations.

  • RandomAudios: Adds a human touch to conversations by seamlessly integrating random voice messages, making your chats more engaging and lively.

POST Bot/Update

{
  "id": "int", // ID of the bot to update
  "name": "string",
  "instructions": "string",
  "followUpInstructions": "string",
  "voiceId": "string",
  "manual": "bool",
  "randomAudios": "bool"
}

//Returns a bool indicating whether the update was successful or not

GET Bot/Get

Returns the list of bots

[{
  "id": "int",
  "name": "string"
}]

GET Bot/Get/{botId}

Returns the bot with the specified bot ID

{
  "id": "int",
  "name": "string",
  "instructions": "string",
  "voiceId": "string",
  "followUpInstructions": "string",
  "manual": "bool",
  "randomAudios": "bool",
  "limit": "int?",
  "test": "bool",
  "userId": "string",
}

GET Bot/Get/{botId}/links

Returns the bot accounts linked to the specified bot ID

[{
  "id": "int", // This is the BotAccountID
  "botId": "int",
  "name": "string"
}]

POST Bot/Disconnect/{botId}

Unlinks the specified bot from any integration

POST Bot/Skill/Add

Adds a skill to the specified bot

The request body must contain the skill definition. Samples:

{
  "botId": int,
  "function": {
    "name": "get_weather",
    "description": "Determine weather in my location",
    "parameters": {
      "type": "object",
      "properties": {
        "location": {
          "type": "string",
          "description": "The city and state e.g. San Francisco, CA"
        },
        "unit": {
          "type": "string",
          "enum": [
            "c",
            "f"
          ]
        }
      },
      "required": [
        "location"
      ]
    }
  }
}
{
  "botId": int,
  "function": {
    "name": "get_stock_price",
    "description": "Get the current stock price",
    "parameters": {
      "type": "object",
      "properties": {
        "symbol": {
          "type": "string",
          "description": "The stock symbol"
        }
      },
      "required": [
        "symbol"
      ]
    }
  }
}

GET Bot/Get/{botId}/skills

Gets the skills of the specified bot ID

POST Bot/Skill/Remove

Removed the specified skill from the specified bot.

The request body must contain the name of the skill to remove. Samples:

{ 
"functionName": "string",
"botId": int 
}
PreviousAuthenticationNextLink bot to channel

Last updated 9 months ago

🚀
🤖