APIHub
Back to Explore

Pandorabots AIaaS

AIaaS provides API access to our bot hosting platform and SDKs, allowing developers to easily integrate conversational interfaces into applications.

Machine Learning
apiKeyQuery
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/atalk/{app_id}/{botname}

Anonymous Talk

  • app_id (path, required) — Your Application ID
  • botname (path, required) — The name of the bot. Format required is 3-64 characters in length and only numbers or lower-case letters [0-9][a-z]
  • input (query, required) — Message to be sent to the bot. This can contain multiple sentences. Currently the limit is 500 characters.
  • client_name (query) — Leave blank to request Pandorabots to create a client_name which will support persistent predicates. Including a valid client_name in this parameter will work in the same way that Talk to Bot API but with persistent predicates. It is recommended to use this API only to create an end-user client_name, and then use normal Talk to Bot API to continue conversation with the bot.
  • sessionid (query) — Session ID generated by Pandorabots. This allows the application to group individual conversations into a collection as needed. If not included in the call, Pandorabots will issue a new session ID. (4-byte integer type)
  • recent (query) — If true, the system will not signal an error if the bot is uncompiled, and will instead look for a previous version of the bot that is available.
GET

/bot/{app_id}

List of bots

  • app_id (path, required) — Your Application ID
DELETE

/bot/{app_id}/{botname}

Delete a bot

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Name of the bot to delete.
GET

/bot/{app_id}/{botname}

List of bot files

  • app_id (path, required) — Your Application ID
  • botname (path, required) — The name of the bot.
  • return (query) — If set to zip, a zip file with all bot files will be returned.
PUT

/bot/{app_id}/{botname}

Create a bot

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Must be unique from all the other bots you have created under this app_id. Can only be numbers and lowercase letters, and must be between 3 and 64 characters long.
GET

/bot/{app_id}/{botname}/verify

Compile a bot

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Your bot's name
DELETE

/bot/{app_id}/{botname}/{file-kind}

Delete a bot file (pdefaults, properties)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Name of the bot.
  • file-kind (path, required) — Specify the type of file being deleted: pdefaults, properties
GET

/bot/{app_id}/{botname}/{file-kind}

Retrieve a bot file (pdefaults, properties)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Name of the bot.
  • file-kind (path, required) — Specify the type of file being retrieved: pdefaults, properties
PUT

/bot/{app_id}/{botname}/{file-kind}

Upload a bot file (pdefaults, properties)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Your bot's name
  • file-kind (path, required) — Specify the type of file being uploaded: pdefaults, properties
DELETE

/bot/{app_id}/{botname}/{file-kind}/{filename}

Delete a bot file (AIML, set, map, substitution)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Name of the bot.
  • file-kind (path, required) — Specify the type of file being deleted: file (for AIML files), map, substitution, set
  • filename (path, required) — Filename to delete. Note: for non-AIML files, do not include the file extension in the path.
GET

/bot/{app_id}/{botname}/{file-kind}/{filename}

Retrieve a bot file (AIML, set, map, substitution)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Name of the bot.
  • file-kind (path, required) — Specify the type of file being retrieved: file (for AIML files), map, substitution, set
  • filename (path, required) — Filename to retrieve. Note: for non-AIML files, do not include the file extension in the path.
PUT

/bot/{app_id}/{botname}/{file-kind}/{filename}

Upload a bot file (AIML, set, substitution, map)

  • app_id (path, required) — Your Application ID
  • botname (path, required) — Your bot's name
  • file-kind (path, required) — Specify the type of file being uploaded: file (for AIML files), map, substitution, set
  • filename (path, required) — Filename to upload, must be named with only lowercase letters and numbers. Note: for non-AIML files, do not include the file extension in the path.
POST

/talk/{app_id}/{botname}

Debug a bot conversation

  • app_id (path, required) — Your Application ID
  • botname (path, required) — The name of the bot. Format required is 3-64 characters in length and only numbers or lower-case letters [0-9][a-z]
  • input (query, required) — Message to be sent to the bot. This can contain multiple sentences. Currently the limit is 500 characters.
  • client_name (query) — Identifies your application's end user. You can assign each of your end users a unique client_name. This will allow you to set predicates and other variable information that is specific to an individual. Format required is 3-64 characters in length and only numbers or lower-case letters [0-9][a-z]
  • sessionid (query) — Session ID generated by Pandorabots. This allows the application to group individual conversations into a collection. While testing your bot, not including this parameter, Pandorabots will issue a new session ID. (4-byte integer type)
  • that (query) — For debugging purposes, you can specify a 'that' with the input that supersedes the existing that in bot memory.
  • topic (query) — For debugging purposes, you can specify a 'topic' with the input that supersedes the existing topic in bot memory.
  • extra (query) — Return extra conversation information. If true, input, pattern, that, topic, filename, and template associated with the pattern matched are returned in addition to response and sessionid.
  • reset (query) — Reset the bot memory. If true, all predicate values in the bot will be discarded, and the user can talk to the bot as if it is the first time
  • trace (query) — Include trace data in the response. If true, the system will generate AIML trace information for the input. Trace data includes pattern matched, filename, input, template for all recursion levels. NOTE: for security reasons, trace does not work with client_name.
  • reload (query) — If true, the system will force a reload of the bot into memory. This can be useful if you've recently uploaded an AIML file, recompiled your bot and want access to your bot's latest changes.
  • recent (query) — If true, the system will not signal an error if the bot is uncompiled, and will instead look for a previous version of the bot that is available.

13 endpoints auto-detected

Authentication

This API uses an API key, passed as the "user_key" query parameter. No OAuth required.

curl -X POST \
  "https://aiaas.pandorabots.com/atalk/{app_id}/{botname}?user_key=YOUR_API_KEY"

aiaas.pandorabots.com · HTTPS only