Skip to main content
All CollectionsOctoparse AI Essentials
API Documentation

API Documentation

Comprehensive guide to Octoparse AI API endpoints

Sophie avatar
Written by Sophie
Updated over a month ago

Endpoint Details

Authentication

URL

https://api.octoparse.com/api/v1/identity/authentication/password

Type

POST

Request

Header

Field

Value

Content-Type

application/json

Body

Parameters

Type

Required

Description

loginName

string

Yes

Username to login

password

string

Yes

Password to the account

Example: 

{
 "loginName": "rpa", "password": "octopusrpa1234" 
}

Response

Parameters

Type

Required

Description

accessToken

string

Yes

Access token used for authentication

accessTokenExpirationTime

string

Yes

Token expiration time

Example:

{ 
"accessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUyNDc4OTQsImV4cCI6MTcxNTMzNDI5NCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MjQ3ODk0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA5VDEwOjI1OjU3KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.NQd3dvRRpgakAd653JyBZ9sGPmC1GeTVzqE2Yks2L2hVmHSd6NtVGittVLg2wF5jTKSBq_Yk3vqO_pZR_ng18VC9xwxS6ikZVyCxJ0pFyrXGkfOiQH3coflecFHCvNOEc6iRAcYnvtbP-vW7RzsbsEoZGFnD3HsBX9y8lrf3X2lESJWwRXXopy0Sxq_BsTBqZE-aH-7edMA2nuacuiGbZ4etkLwJHi8jiPC1IG6nQT-nGc5A2IXL11vVVXi4vgYq8yzFOWx4Df1d67mZOkCrFY7FohPiqK95qGKPLVY5SkqbxOk2qyDgMsfEwQUmEB6KNZsgHL10Pqbys2rHTP8MSg", 
"accessTokenExpirationTime": "2024-05-10T09:44:54+00:00", 
"refreshToken": "5jUQ8TZqlFz72CmuRgnSzwAOf5UCSxosxDI5GLpmq54", 
"refreshTokenExpirationTime": "2024-05-16T09:44:54+00:00"
 }

Webhook

Url

retrieve from Webhook trigger

Type

POST

Request

Header

Field

Value

Content-Type

application/json

Body

Parameters

Type

Required

Description

loginName

string

Yes

Generated by encrypting the timestamp combined with the signing key using the HmacSHA256 algorithm. The signature string is constructed as timestamp + "\n" + signing key. The resulting hash is then Base64 encoded.

params

object

No

{ 
"app_param_1": "Custom parameter for the task", // e.g., 
account "app_param_2": "Custom parameter for the task" // e.g., password
}

specifiedBot

string

Yes

The ID of a specific bot, which can be obtained from the Enterprise Console.

timestamp

string

Yes

The current time, represented as a Unix timestamp (in seconds).

Example: 

{
 "loginName": "rpa", "password": "octopusrpa1234" 
}

Response

Http Code 200: Successfully started

Parameters

Type

Required

Description

enterpriseId

string

Yes

The ID of enterprise account

flowId

string

Yes

The ID of a specific app

processNo

string

Yes

The execution batch number of the app

Example:

{ 
"enterpriseId": "65d413751fdff0e15cad6627", 
"flowId": "660b796f5db3eedaa9587bbd", 
"flowProcessNo": "638508224789866966" 
}

Http Code 400: Failed to start

Parameters

Type

Required

Description

code

string

Yes

Failure code

description

string

No

Failure description

requestId

string

Yes

The ID of request

Task Status Query

Url

  • URL Path Parameters:

    • flowId - The ID of the app

    • flowProcessNo - The execution batch number of the app

Type

GET

Request

Header

Field

Value

Content-Type

application/json

Authorization

"Bearer" + " " + accessToken

EnterpriseId

enterpriseId returned by the Webhook endpoint.

Request URL Example

GET https://api.octoparse.ai/api/v1/bots/runningRecords/flow-660b796f5db3eedaa9587bbd/process-638506737195684939

Request Header Example

Field

Value

EnterpriseId

65d413751fdff0e15cad6627

Authorization

Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA

Response

Http Code 200: Query successful

Parameters

Type

Required

Description

flowId

string

Yes

The ID of a specific app

flowProcessNo

string

Yes

The execution batch number of the app

botId

string

No

The ID of a specific bot

botName

string

No

The name of a specific bot

startWay

string

Yes

Start mode:

  • Manual

  • TimingTrigger

  • WebhookTrigger

status

string

Yes

Bot status：

  • Empty – No task assigned.

  • Waiting – Pending execution.

  • Scheduled – Task assigned.

  • Delivered – Task received by the bot.

  • Executing – In progress.

  • Stopping – Stopping.

  • Stopped – Stopped.

  • Finished – Completed.

  • Failed – Execution failed.

  • Cancelled – Execution cancelled.

statusMessage

string

No

Information of the bot status

startTime

string

Yes

When the bot starts

endTime

string

No

When the bot ends

executionStartTime

string

No

When the app starts execution

Response example

{ 
"flowId": "660b796f5db3eedaa9587bbd", 
"flowProcessNo": "638506737195684939", 
"flowName": "Get news", 
"botId": "65d413751fdff0e15cad6627_99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", 
"botName": "Bot-DESKTOP-NJDIBNV", 
"starterId": null, 
"starterName": null, 
"triggerId": "6639f1689273785531999a5b", 
"triggerName": "OpenAPI_Test", 
"timingTriggerId": "6639f1689273785531999a5b", 
"timingTriggerName": "OpenAPI_Test", 
"startWay": "Webhook", 
"status": "Executing", 
"statusMessage": null, 
"startTime": "2024-05-07T10:15:19.567+00:00", 
"endTime": null, 
"executionStartTime": "2024-05-07T10:42:44.877+00:00" 
}

Http Code 400: Query failed

Parameters

Type

Required

Description

code

string

Yes

Failure code

description

string

No

Failure description

requestId

string

Yes

The ID of request

Response example：

{ 
"code": "SignatureVerificationFailureOrTimestampExpired", 
"description": "Signature mismatch or the timestamp is not within one hour of the current time.", 
"requestId": "0HN3EGCVKSHDK:00000001" 
}

Stop Task

Url

https://api.octoparse.ai/api/v1/bots/scheduling/stop

Type

POST

Request

Header

Field

Value

Content-Type

application/json

EnterpriseId

enterpriseId

Body

Parameters

Type

Required

Description

flowId

string

Yes

The ID of a specific app

flowProcessNo

string

Yes

The execution batch number of the app

Request URL Example

POST https://api.octoparse.ai/api/v1/bots/scheduling/stop

Request Header Example

parameters

Value

EnterpriseId

65d413751fdff0e15cad6627

Authorization

Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA

Request Body Example

{ 
"flowId": "660b796f5db3eedaa9587bbd", 
"flowProcessNo": "638508434307732021", 
}

Response

Http Code 200: Success

Http Code 400: Failed

Parameters

Type

Required

Description

code

string

Yes

Failure code

description

string

No

Failure description

requestId

string

Yes

The ID of request

Bot List

Url

https://api.octoparse.ai/api/v1/bots/management/bots?search={search}&start={start}&take={take}

Type

GET

Request

Header

Field

Value

Content-Type

application/json

Authorization

"Bearer" + " " + accessToken

returned by the Authentication endpoint.

EnterpriseId

enterpriseId

returned by the Webhook endpoint.

URL parameters

Parameters

Type

Required

Description

search

string

No

The search keyword. You can search by bot name, machine name, or description. (Note: URL encoding is required.)

start

int

No

The starting position, starting from 0. Default is 0.

take

int

No

The number of records to retrieve. Default is 20.

Request example

GET https://api.octoparse.ai/api/v1/bots/management/bots?search=%E6%9C%BA%E5%99%A8%E4%BA%BA&start=0&take=20

Header example

parameters

Value

EnterpriseId

65d413751fdff0e15cad6627

Authorization

Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA

Response

Http Code 200: Query successful

Parameters

Type

Required

Description

item

Bot[]

Please refer to the Bot Entity part

Yes

Bot information

total

string

Yes

Quantity of bots

Response Example

{ 
"items": [ 
{
"id": "99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", 
"name": "Bot-DESKTOP-NJDIBNV", 
"intro": null, 
"machineName": "DESKTOP-NJDIBNV", 
"machineIp": "172.22.0.1", 
"version": "0.2.22.1118", 
"isConnected": false, 
"isEnabled": true, 
"executionStatus": "Empty", 
"lastConnectingTime": "2024-11-20T02:44:01.007+00:00", "lastDisconnectingTime": "2024-11-20T02:48:30.189+00:00", 
"isBusy": false, 
"flowId": null, 
"flowProcessNo": null 
} 
], 
"total": 1 
}

Get Bot Information

Url

https://api.octoparse.ai/api/v1/bots/management/bots/{botId}

Type

GET

Request

Header

Field

Value

Content-Type

application/json

Authorization

"Bearer" + " " + accessToken

returned by the Authentication endpoint.

EnterpriseId

enterpriseId

returned by the Webhook endpoint.

URL parameters

Parameters

Type

Required

Description

botId

string

Yes

ID of the bot

Request URL Example

GET https://api.octoparse.ai/api/v1/bots/management/bots/99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0

Header Example

parameters

Value

EnterpriseId

65d413751fdff0e15cad6627

Authorization

Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImdXS3hWc0F4SHhaMDlDcWh6NkNJb3ciLCJ0eXAiOiJhdCtqd3QifQ.eyJuYmYiOjE3MTUxNjI4MjQsImV4cCI6MTcxNTI0OTIyNCwiaXNzIjoiaHR0cHM6Ly9wcmUtaWRlbnRpdHkuYmF6aHVheXUuY29tIiwiYXVkIjpbIkNsaWVudEFwaSIsIkRhdGFBcGkiLCJBZHZhbmNlZEFwaSIsIkNsb3VkQWdlbnQiLCJDbHVzdGVyU2VydmljZSJdLCJjbGllbnRfaWQiOiJPY3RvcHVzIiwic3ViIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiYXV0aF90aW1lIjoxNzE1MTYyODI0LCJpZHAiOiJsb2NhbCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWVpZGVudGlmaWVyIjoiOTliYjYwYTEtNWI1Mi00MzAwLTlmZmQtNjgxNTMzYzZmMzQ4IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSI6InNraWVlcndlbiIsInByZWZlcnJlZF91c2VybmFtZSI6InNraWVlcndlbiIsInVuaXF1ZV9uYW1lIjoic2tpZWVyd2VuIiwicmVnaXN0ZXJfZGF0ZSI6IjIwMTYtMTEtMDNUMDY6Mzk6MjArMDg6MDAiLCJsYXN0X2xvZ2luX2RhdGUiOiIyMDI0LTA1LTA3VDE3OjIwOjI1KzA4OjAwIiwibGFzdF9wYXNzd29yZF9jaGFuZ2VkX2RhdGUiOiIyMDIyLTEwLTI2VDEyOjI5OjQ2KzA4OjAwIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvZW1haWxhZGRyZXNzIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsIjoid2VuZGlAc2tpZWVyLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3JvbGUiOlsiT3BzIiwiQnVzaW5lc3NDZW50ZXIiXSwic2NvcGUiOlsib3BlbmlkIiwicHJvZmlsZSIsImVtYWlsIiwiQ2xpZW50QXBpIiwiRGF0YUFwaSIsIkFkdmFuY2VkQXBpIiwiQ2xvdWRBZ2VudCIsIkNsdXN0ZXJTZXJ2aWNlIl19.hkFNws955sUm3jvAp2ijf6YVz9z10eGuvwez0aT4wi9b5il7zfD5DU2xDcp44CKhN9Wc-9Cy7-RSjDtkmF4EM8CLNs4VPda9EC1BV8md94WaHZIbyJzTyiOXQXEhVtpS8Y_9cQZyhh5WGanD8G2GOWv4cntKMkC4OLmGSXPO95RRkC3DNUXcTwspNVnHt72C7EmQW0kipuPQ83sRXvStuIvvdzb9kNNn5T-6s3ROcvofi1BYeE_19hF0UBs1IA3IJq8oyjUw4MvffzV6ihLVklmbWjWl3VjFoq9p2G5X2dWvqzhJ0am9QazX3e9MNmOBhYlEx0n-1PM90c5xfs-0zA

Response

Http Code 200: Query successful

Example

{ 
"id": "99bb60a1-5b52-4300-9ffd-681533c6f348_TRZMNZQ1G8YZ0D5NC9A1HF3QD99Z4DMAZ3X8GXG5PZFVE27YMWP0", 
"name": "Bot-DESKTOP-NJDIBNV", 
"intro": null, 
"machineName": "DESKTOP-NJDIBNV", 
"machineIp": "172.22.0.1", 
"version": "0.2.22.1118", 
"isConnected": false, 
"isEnabled": true, 
"executionStatus": "Empty", 
"lastConnectingTime": "2024-11-20T02:44:01.007+00:00", "lastDisconnectingTime": "2024-11-20T02:48:30.189+00:00", 
"isBusy": false, "flowId": null, 
"flowProcessNo": null 
}

Entity Definitions

Bot Entity

Parameters

Type

Required

Description

id

string

Yes

ID of the bot

name

string

Yes

Name of the bot

intro

string

No

Description of the bot

machineName

string

Yes

The name of the device where the bot installed

machineIp

string

Yes

The IP of the device where the bot installed

version

string

Yes

Version of the bot client

isConnected

bool

Yes

Whether the bot is connected

isEnabled

bool

Yes

Whether the bot is enabled

executionStatus

string

Yes

Bot status：

  • Empty – No task assigned.

  • Waiting – Pending execution.

  • Scheduled – Task assigned.

  • Delivered – Task received by the bot.

  • Executing – In progress.

  • Stopping – Stopping.

  • Stopped – Stopped.

  • Finished – Completed.

  • Failed – Execution failed.

  • Cancelled – Execution cancelled.

lastConnectingTime

string

Yes

Time for the last connection

flowId

string

No

The Id of the currently running app

flowProcessNo

string

No

The batch number of the currently running app

Did this answer your question?