Deploy a Tool

Agent Platform supports both synchronous and asynchronous tool deployment modes.

Note

Before deploying the tool, you must fix any errors or warnings in the Tool Flow.

Synchronous Endpoint

A synchronous endpoint handles requests and responses immediately and sequentially. The client waits for the server to process the request and return a response before proceeding. This approach is suitable for real-time operations requiring immediate response.

Asynchronous Push and Poll Endpoints

Push endpoints actively send data to the client, while poll endpoints require the client to retrieve the data on their own. The key difference between asynchronous push and poll endpoints is how the response data is delivered to the client.

Asynchronous Push Endpoints

• The integration "pushes" the response data to the client as soon as it becomes available.
• This allows the client to receive updates in real-time or near real-time.
• The client sets up a webhook or other mechanism to receive the pushed data.
• Useful for integrations where the client needs to be notified of changes immediately.

Asynchronous Poll Endpoints

• The client "polls" or periodically checks the integration to fetch the response data.
• The client initiates the requests to retrieve the data on their schedule.
• The client is responsible for checking for new data rather than waiting for it to be pushed.
• Useful for integrations where the client only needs to check for updates at specific intervals.

Deploy an Tool

Steps to deploy an tool:

1. On the Tools tab, click the name of the tool that you want to deploy and then click Tool endpoint in the left navigation.

2. The Tool endpoint page is displayed. Click Deploy.
   

3. The tool is deployed and the Sync and Async poll endpoints are generated.
   

4. If you want to generate an Async push endpoint for the tool, do the following:

   1. Click the Async push tab and click Enable/Settings.
      

   2. The Sync/Async mode setup pop-up displays with sync mode disabled by default.

      • Synchronous mode timeout. The allowed range is 60 to 300 seconds (5 minutes). The default is 180 Seconds (3 minutes). The endpoint will trigger a timeout error if the request is not completed within the selected time frame.

      • Asynchronous mode configuration: Turn on the Enable async toggle and do the following:

        1. Provide the URL of your external application to which messages are to be delivered.
        2. Enter the access token generated by the external application.
        3. Set the Asynchronous mode timeout duration:
           • Set timeout: The allowed timeout range is 60 seconds to 600 seconds (10 minutes). The default is 180 Seconds (3 minutes).
           • No timeout: This allows the tool to process the request without a time limit.
             

      Note

      Timeout precedence: Tool timeout > Node timeout > Model timeout.

   3. Click Save. The async push endpoint is created.
      

Redeploy a Tool for the Changes in the Flow

The Deployed version of your tool's flow is accessible from the Tool Flow page. You can click the View the Flow button to view the flow in read-only mode.

You can change the in-development version of the flow. To redeploy the tool with the updated flow, click the Deploy button at the top-right corner of the Tool endpoint page. The redeployment doesn't change the tool's endpoint.