API Task real-time endpoint

Instantly invoke API Tasks with a real-time endpoint. You can generate an API Task execution URL along with a token to start an API Task execution through an API endpoint.

Key benefits

  • Programmatic deployment: Invoke API Task from anywhere real-time using your preferred API client.
  • Response time: Designed for low latency with near real-time response rates, aiming to provide responses almost instantly (typically within milliseconds).
  • Processing:
    • Automations are loaded into cloud and ready to accept requests at all times. This allows for quick processing and response.
    • Premium license helps to scale your automation and provide access to a larger pool of cloud resources that can execute multiple instances of your API Task, boosting concurrency and enabling you to handle more API Task requests simultaneously.
  • Use cases:
    • Ideal for interactive situations like chatbots
    • real-time fraud detection
    • Online case creations
    • or any use case where instant response is crucial

Prerequisites

The following sample code snippets provide you with a procedure to deploy an API Task real-time to a cloud device. You can also pass variables to API Tasks when they are deployed.

Step 1: API Task real-time endpoint - Authenticate
Authenticate access to your Control Room instance.
Step 2: Create an API Task allocation (admin)
An admin can create an API Task allocation.
Step 3: List API Task allocation (admin)
An admin can list all the API Task allocations.
Step 4: Generate Task Execution URL/Token
Generate the URL and Token to deploy your API Task.
Step 5: Execute API Task real-time endpoint
Execute your API Task with the unique URL generated along with the token..