Automations

Get Automation

The endpoint makes an HTTP GET request to retrieve a list of automations from the specified URL.

The response of this request can be documented as a JSON schema:

{
 "type": "object",
 "properties": {
 "status": {
 "type": "string"
 },
 "data": {
 "type": "object",
 "properties": {
 "totalCount": {
 "type": "integer"
 },
 "automationList": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "trigger": {
 "type": "object",
 "properties": {
 "type": {
 "type": "string"
 },
 "folderIds": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "name": {
 "type": "string"
 },
 "folderId": {
 "type": "string"
 }
 }
 }
 },
 "values": {
 "type": "array"
 }
 }
 },
 "action": {
 "type": "object",
 "properties": {
 "magicPrompt": {
 "type": "object",
 "properties": {
 "title": {
 "type": "string"
 },
 "assistantType": {
 "type": "string"
 },
 "assistantTemplateId": {
 "type": "string"
 },
 "prompt": {
 "type": "string"
 }
 }
 },
 "type": {
 "type": "string"
 }
 }
 },
 "name": {
 "type": "string"
 },
 "description": {
 "type": "string"
 },
 "runType": {
 "type": "string"
 },
 "isActive": {
 "type": "boolean"
 },
 "automationId": {
 "type": "string"
 },
 "actionHistory": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "type": {
 "type": "string"
 }
 }
 }
 },
 "createdAt": {
 "type": "string"
 },
 "updatedAt": {
 "type": "string"
 },
 "history": {
 "type": "integer"
 }
 }
 }
 }
 }
 }
 }
}

get/automations/{automationId}

Request

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

Path parameters

automationIdstring required

Response

Success

Changes

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