All REST Endpoints
Digital Assistants
Use this API to get information about digital assistants.
- List Digital Assistants
- Method: getPath:
/api/v1/digitalAssistants
Dynamic Entities
Use this API to manage the values of dynamic value-list entities.
- Create Push Request
- Method: postPath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests
- Delete Push Request
- Method: deletePath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}
- Finalize or Abort Push Request
- Method: putPath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/{action}
- Get Dynamic Entities
- Method: getPath:
/api/v1/bots/{botId}/dynamicEntities
- Get Push Request
- Method: getPath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}
- List Push Requests
- Method: getPath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests
- Push Data to Request
- Method: patchPath:
/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/values
Insights Export
Use this API to create and manage tasks to export insights data. The task can optionally purge the data after it's exported. The exported data is stored in the instance in a downloadable ZIP file.
- Cancel and delete export task
- Method: deletePath:
/api/v1/bots/insights/dataExports/{id}
- Get Export File
- Method: getPath:
/api/v1/bots/insights/dataExports/{id}/files/{filename}
- Get Export Task Status
- Method: getPath:
/api/v1/bots/insights/dataExports/{id}
- List Export Tasks
- Method: getPath:
/api/v1/bots/insights/dataExports
- Start Export Task
- Method: postPath:
/api/v1/bots/insights/dataExports
Insights for Skills (Deprecated)
Deprecated. Use this API to manage jobs to export a skill's insights data that was collected from conversations and to download the data in CSV files.
- Delete Export Task
- Method: deletePath:
/api/v1/bots/{botId}/insightExports/{exportId}
- Get Export List
- Method: getPath:
/api/v1/bots/{botId}/insightExports
- Get Export Task
- Method: getPath:
/api/v1/bots/{botId}/insightExports/{exportId}
- Get Export Task Status
- Method: getPath:
/api/v1/bots/{botId}/insightExports/{exportId}/status
- Get Exported Data
- Method: getPath:
/api/v1/bots/{botId}/insightExports/{exportId}/data
- Start Export Task
- Method: postPath:
/api/v1/bots/{botId}/insightExports
Insights for the Instance (Deprecated)
Deprecated. Use this API to manage jobs to export a service instance's insights data that was collected from conversations and to download the data in CSV files.
- Delete Export Task
- Method: deletePath:
/api/v1/bots/insightDataExport/{exportId}
- Get Export Task
- Method: getPath:
/api/v1/bots/insightDataExport/{exportId}
- Get Exported Data
- Method: getPath:
/api/v1/bots/insightDataExport/{exportId}/data
- List Export Tasks
- Method: getPath:
/api/v1/bots/insightDataExport
- Start Export Task
- Method: postPath:
/api/v1/bots/insightDataExport
Metadata Migration
Use this API to migrate dynamic entities and resource bundles from an older version of a skill to a new one.
- Delete Dynamic Entities Migration Requests
- Method: deletePath:
/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests/{migrationRequestId}
- Get Dynamic Entities Migration Requests
- Method: getPath:
/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests/{migrationRequestId}
- List Dynamic Entities Migration Requests
- Method: getPath:
/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests
- List Migration Request Push Requests
- Method: getPath:
/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests/{migrationRequestId}/pushRequests
- Migrate Resource Bundles
- Method: postPath:
/api/v1/bots/{botId}/metadataMigration/resourceBundles
- Start a Dynamic Entities Migration
- Method: postPath:
/api/v1/bots/{botId}/metadataMigration/dynamicEntitiesMigrationRequests
Resource Bundles
Use this API to change the messages and annotations in a skill's resource bundles. You also can add messages for languages other than the default (primary) language.
- Add Messages
- Method: postPath:
/api/v1/bots/{botId}/bundles
- Change Messages
- Method: patchPath:
/api/v1/bots/{botId}/bundles
- List Messages
- Method: getPath:
/api/v1/bots/{botId}/bundles
Sessions
Use this API to retrieve a session's conversation log.
- Get Conversation Log
- Method: getPath:
/api/v1/bots/sessions/{channelId}/{userId}/{sessionId}/log
Skills
Use this API to get information about skills.
- List Skills
- Method: getPath:
/api/v1/skills