Run

Run an automation

Get connectedAccountId from this API.

Get automationId from this API.

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-TexAu-ContextstringRequired

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

Body
namestringRequired
descriptionstringOptional
automationIdstringRequired
connectedAccountIdstringOptional
timezonestringOptional
inputsobjectRequired
Responses
201

Automation started running successfully

application/json
post
/api/v1/public/run

Run a workflow

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

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
workflowIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

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

Responses
201

Workflow execution started successfully

application/json
post
/api/v1/public/run/{workflowId}

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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
workflowIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

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

Responses
201

Workflow inputs fetched successfully

application/json
get
/api/v1/public/inputs/{workflowId}

No content

The above API will give a response like this :

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:

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
workflowIdstringRequired
Header parameters
X-TexAu-ContextstringRequired

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

Body
inputsobjectRequired
socialAccountIdsobjectRequired
Responses
201

Workflow execution started successfully

application/json
post
/api/v1/public/configure-run/{workflowId}

Run Automation with CSV input

API for uploading CSV file

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-TexAu-ContextstringRequired

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

Body
filenamestring · binaryOptional

Upload file. Supported types: image/, application/

Responses
201

File uploaded successfully

application/json
post
/api/v1/public/csv-upload

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

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
X-TexAu-ContextstringRequired

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

Body
namestringRequired
descriptionstringOptional
automationIdstringRequired
connectedAccountIdstringOptional
csvUrlstringOptional
timezonestringOptional
inputsobjectRequired
Responses
201

Automation started running successfully

application/json
post
/api/v1/public/csv-input/run

Last updated