Run

Run an automation

Get connectedAccountId from this API.

Get automationId from this API.

post

/api/v1/public/run

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

namestringrequired

descriptionstring

automationIdobjectrequired

connectedAccountIdobject

timezonestring

inputsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/run' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "automationId": {},
    "connectedAccountId": {},
    "timezone": "text",
    "inputs": {}
  }'

201

401

403

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "workflowId": "text"
  }
}

Automation started running successfully

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}

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/run/{workflowId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

201

401

403

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "workflowId": "text"
  }
}

Workflow execution started successfully

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}

Authorizations

Path parameters

workflowIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/inputs/{workflowId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

201

204

401

422

500

200

No body

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}

Authorizations

Path parameters

workflowIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

inputsobjectrequired

socialAccountIdsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/configure-run/{workflowId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "inputs": {},
    "socialAccountIds": {}
  }'

201

204

401

422

500

201

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

Workflow execution started successfully

Run Automation with CSV input

API for uploading CSV file

post

/api/v1/public/csv-upload

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

filenamestring · binary

Upload file. Supported types: image/, application/

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/csv-upload' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: multipart/form-data' \
  --form 'filename=text'

201

401

403

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "csvUrl": "text"
  }
}

File uploaded successfully

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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

namestringrequired

descriptionstring

automationIdobjectrequired

connectedAccountIdobjectrequired

csvUrlstring

timezonestring

inputsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/csv-input/run' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "automationId": {},
    "connectedAccountId": {},
    "csvUrl": "text",
    "timezone": "text",
    "inputs": {}
  }'

201

401

403

422

500

201

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "workflowId": "text"
  }
}

Automation started running successfully