Automations

Get Automations

The endpoint retrieves a list of automations via an HTTP GET request to {{url}}/v1/automations.

Response

The response will be in the form of a JSON schema, with the following structure:

{
 "status": "",
 "data": {
 "totalCount": 0,
 "automationList": [
 {
 "trigger": {
 "folderIds": [
 {
 "name": "",
 "folderId": ""
 }
 ],
 "values": [],
 "type": ""
 },
 "action": {
 "magicPrompt": {
 "title": "",
 "assistantType": "",
 "prompt": ""
 },
 "type": ""
 },
 "name": "",
 "description": "",
 "runType": "",
 "isActive": true,
 "automationId": "",
 "actionHistory": [
 {
 "type": ""
 }
 ],
 "createdAt": "",
 "updatedAt": "",
 "history": 0
 }
 ]
 }
}

The response will have a status code of 200 upon successful retrieval of the automation list.

For related responses from other endpoints of this API, the data model will be largely similar, with the addition of "email", "accessToken", and "refreshToken" fields in the "data" object, and a status code of 200.

get/automations

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/automations
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Response

Success

Changes

No recorded changes to this operation across all 2 revisions of this API.