Run

Run an automation

Get connectedAccountId from this API.

Get automationId from this API.

post

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

namestringrequired

descriptionstringoptional

automationIdstringrequired

connectedAccountIdstringoptional

timezonestringoptional

inputsobjectrequired

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/v1/public/run HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "name": "text",
  "description": "text",
  "automationId": "text",
  "connectedAccountId": "text",
  "timezone": "text",
  "inputs": {}
}

{
  "success": true,
  "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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/v1/public/run/{workflowId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "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

Authorizations

Path parameters

workflowIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

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

Responses

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/public/inputs/{workflowId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

No Content

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

Authorizations

Path parameters

workflowIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

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

Body

inputsobjectrequired

socialAccountIdsobjectrequired

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/v1/public/configure-run/{workflowId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "inputs": {},
  "socialAccountIds": {}
}

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

Run Automation with CSV input

API for uploading CSV file

post

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

filenamestring · binaryoptional

Upload file. Supported types: image/, application/

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/v1/public/csv-upload HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 21

{
  "filename": "binary"
}

{
  "success": true,
  "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

Authorizations

Header parameters

X-TexAu-Contextstringrequired

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

Body

namestringrequired

descriptionstringoptional

automationIdstringrequired

connectedAccountIdstringoptional

csvUrlstringoptional

timezonestringoptional

inputsobjectrequired

Responses

application/json

objectoptional

post

HTTPcURLJavaScriptPython

POST /api/v1/public/csv-input/run HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "name": "text",
  "description": "text",
  "automationId": "text",
  "connectedAccountId": "text",
  "csvUrl": "text",
  "timezone": "text",
  "inputs": {}
}

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