Run

Run an automation

Get connectedAccountId from this API.

Get automationId from this API.

POST/api/v1/public/run

Authorization

bearer

Header parameters

Body

application/json

name*string

descriptionstring

automationId*string

connectedAccountIdstring

timezonestring

inputs*object

Response

201204401422500

Automation started running successfully

Body

application/json

success*boolean

message*string

Example: "Execution started"

data*RunData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/run', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "automationId": "text"
    }),
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "Execution started",
  "data": {
    "id": "The Execution ID",
    "workflowId": "The Workflow ID"
  }
}

Run a workflow

This API will be used to start a workflow using workflowId, you can get workflowId from this API

POST/api/v1/public/run/{workflowId}

Authorization

bearer

Path parameters

workflowId*string

Header parameters

Response

201204401422500

Workflow execution started successfully

Body

application/json

success*boolean

message*string

Example: "Execution started"

data*RunData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/run/{workflowId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "Execution started",
  "data": {
    "id": "The Execution ID",
    "workflowId": "The Workflow ID"
  }
}

Get All Required Inputs For A Workflow

This API will give you data for required inputs of a workflow and platformId for which social Account ID will be passed in the next API call

GET/api/v1/public/inputs/{workflowId}

Authorization

bearer

Path parameters

workflowId*string

Header parameters

Response

200201204401422500

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/inputs/{workflowId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text"
    },
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "Inputs required for workflow fetched successfully",
  "data": {
    "requiredInputs": {
      "automationId": [
        {
          "name": "The input name, e.g., liProfileUrl",
          "label": "The input label, e.g., Profile URL",
          "description": "The input description, e.g., Linkedin Profile URL",
          "type": "The input type, e.g., text",
          "isRequired": true,
          "choices": []
        }
      ]
    },
    "socialAccountNeeded": "622f03eb770f6bba0b8facaa"
  }
}

The above API will give a response like this :

{
  "success": true,
  "message": "Inputs required for workflow fetched successfully",
  "data": {
    "requiredInputs": {
      "{{automationId1}}": [
        {
          "name": "liProfileUrl",
          "label": "Profile URL",
          "description": "LinkedIn Profile URL",
          "type": "text",
          "isRequired": true,
          "choices": []
        },
        {
          "name": "maxCount",
          "label": "Extract Limit",
          "description": "Recent Activity Extract Limit (Max. 1000)",
          "type": "number",
          "isRequired": false,
          "choices": []
        }
      ]
    },
    "socialAccountNeeded": [
      "{{platformId}}"
    ]
  }
}

Configure and Run Workflow

This API will be used to configure workflow inputs, and social accounts and start the workflow.

This will take a body like this:

{
  "inputs": {
    "{{automationId1}}": {
      "{{inputName1}}": "{{inputValue1}}",
      "{{inputName2}}": "{{inputValue2}}",
    }
  },
  "socialAccountIds": {
    "{{platformId}}": "{{socialAccountId}}"
  }
}

POST/api/v1/public/configure-run/{workflowId}

Authorization

bearer

Path parameters

workflowId*string

Header parameters

Body

application/json

inputs*object

socialAccountIds*object

Response

201204401422500

Workflow execution started successfully

Body

application/json

success*boolean

message*string

Example: "Execution started"

data*RunData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/configure-run/{workflowId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "Execution started",
  "data": {
    "id": "The Execution ID"
  }
}

Run Automation with CSV input

API for uploading CSV file

POST/api/v1/public/csv-upload

Authorization

bearer

Header parameters

Body

multipart/form-data

filenamestring (binary)

Response

201204401422500

File uploaded successfully

Body

application/json

success*boolean

message*string

Example: "File uploaded successfully"

data*FileData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/csv-upload', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "File uploaded successfully",
  "data": {
    "csvUrl": "https://v2.s3.us-west-1.amazonaws.com/643fba392c9f900612b4/635c375f-2f3e-4745-8e79-8abe81ad97e7.csv"
  }
}

API to invoke automation via CSV Url

You'll get csvUrl from the above API call.

Create inputs object like this.

The key will be the input name and the value will be that CSV header which will be used as actual input.

Suppose CSV have 3 Headers: Profile URL, Keyword & Profile Picture. Now the inputs object will look like

inputs: {"liProfileUrl": "Profile URL"}

POST/api/v1/public/csv-input/run

Authorization

bearer

Header parameters

Body

application/json

name*string

descriptionstring

automationId*string

connectedAccountId*string

csvUrl*string

timezonestring

inputs*object

Response

201204401422500

Automation started running successfully

Body

application/json

success*boolean

message*string

Example: "Execution started"

data*RunData (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/public/csv-input/run', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "X-TexAu-Context": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "automationId": "text",
      "connectedAccountId": "text",
      "csvUrl": "text"
    }),
});
const data = await response.json();

Response

201

{
  "success": false,
  "message": "Execution started",
  "data": {
    "id": "The Execution ID",
    "workflowId": "The Workflow ID"
  }
}