Online Documents
English
English
  • First Launch Experience
  • Activate Software License
  • How to Train EMILY?
  • Simple Web Automation
  • Web Automation Tools
  • Web Automation Processor
  • User Fill
  • Workspace Script
  • File Exporter
  • File Enumerator
  • EXCEL Processor
  • EXCEL Analyzer
  • EXCEL Writer
  • EXCEL Filler
  • CSV Creator
  • PowerShell
  • PDF Analyzer
  • Mail Sender
  • Mail Reader
  • Exchange Mail Sender
  • Exchange Mail Reader
  • HTTP Analyzer
  • Command Line
  • DOCX Templater
  • SQL Executor
  • Desktop Automation (DA)
  • SFTP
  • JSON API Server
  • Chart
  • DOCX2HTML
  • Manage Folder
  • Google Drive
  • Google Sheets
  • Google OCR
  • Google NLU
  • Azure Form Recognizer
  • Anti-Captcha
  • ChatGPT
  • Gemini
  • Schedule Trigger
  • Mail Trigger
  • File Trigger
  • API Trigger
  • Protect Text
  • Flexibility & Security
  • Announcements
    • Version Release
    • Third Party Notice
Powered by GitBook
On this page
  • Enable API Trigger
  • Add to API
  • Inquire Working Status

API Trigger

Use the HTTP API to trigger the specified Automation Skill. The skill shares the same queue with all other skills triggered, and is executed sequentially

PreviousFile TriggerNextProtect Text

Last updated 1 year ago

Enable API Trigger

After triggering the API, EMILY will start the API server. The "uuid" parameter is the identifier for the desired automation skill. For example, "GET http://ip-address:port/api?uuid=1a2b" means requesting EMILY to execute the automation skill with the identifier "1a2b." If you want to upload files required for the automation skill as input, you can use "POST http://ip-address:port/api?uuid=1a2b" and upload the input files as "multipart/form-data." The following image demonstrates this using the HTTP tool Postman:

Add to API

After clicking on any skill, a menu will pop up, and by selecting Add to API, you can make this skill available for other devices on the same network to request EMILY to execute through an API.

Inquire Working Status

To obtain the overall working status of EMILY, you can use a GET request to the endpoint "/api" without the need for any parameters. The working status will include information such as whether it is currently executing ("executing"), the length of the waiting queue ("waiting"), and the number of completed tasks ("finished").

When you trigger a skill using the API, it will return a JSON object like this: { "msUnixTime": "1656215466302" }, which signifies that the specified skill has been queued for execution. The caller can then use the "GET /api/job?uuid=1a2b&msUnixTime=1234" endpoint to obtain the current status of this job. The status may include inqueue, executing, or finished:

--

We are dedicated to improving our content. Please let us know if you come across any errors, including spelling, grammar, or other mistakes, as your is valuable to us! 🤖️⚡️

feedback
Job in Pending
Job in progress