To create an endpoint, click the "Endpoint" menu item to open the endpoint list, then click the "+ API Endpoint" button. The list shows Endpoint, Current deployment, Release, Instance, and Region.

On the form, enter an Endpoint name. The name also forms the endpoint URL shown under it: https://<instance host>/v1/execute/<name>. The form generates an API key and shows it masked. Use the buttons to show, copy, or regenerate the key. An endpoint name that is already taken is refused.

You can save the new endpoint with CTRL+S or the Save button. After saving, the endpoint page opens. At the top, the Endpoint URL has a Realtime / Webhook switch. Realtime shows .../v1/execute/<name>. Webhook shows .../v1/webhook/<name>.

The page shows the API key and a card with the instance, decision flows, deployment emails, production endpoint, and Block deletion.

image-20241202-103935.png

A different region can be used to create an endpoint. However, when a decision engine is used, where the speed of execution matters, the location of an endpoint is crucial. You can get in touch with us if there is a place or region that you would like to have because it is close to your own.

Limiting decision flow

An endpoint can limit which decision flow releases can be deployed to it. The Decision flows row lists the allowed decision flows as chips. Each chip has a remove cross, and + Add lets you allow more. If no decision flows are listed, any decision flow release can be deployed to the endpoint. Once at least one is listed, only releases of the listed decision flows can be deployed.

image-20241202-104126.png

This is helpful if you want to avoid routing a decision flow to the wrong endpoint and have various business use cases.

Notification about deployments

Deployment is a process when you define which release should be used on an Endpoint. Deployment is the process used when decision logic changes and is usually important for business. As such, some people may need to be notified when a deployment is done. You can define which users are notified when a new deployment is done on an endpoint.

A switch controls deployment emails. When it is on, a chip list lets you add registered users who receive an email whenever a deployment is made on the endpoint.

Other endpoint settings

The Approval sequence dropdown appears on the endpoint card when you have approval sequences. It names the approval sequence that a deployment to this endpoint goes through. None means that the deployment has no approval.

The Production endpoint switch marks the endpoint as a production endpoint. Production endpoints appear first in the AI register.

The Block deletion switch controls the Delete command in the endpoint's settings menu. The menu is the gear at the top right of the page. When Block deletion is on, Delete is disabled until you switch it off.

The Shadow card appears below the endpoint card. It runs another release on the endpoint's live traffic beside the live release, which continues to answer every call. The card shows the share of decisions that agree and provides Analyze, Promote, and Stop shadow actions. Shadow requires a release deployed to the endpoint first.

Deployment history

The deployment history table lists each deployment, who deployed it, when it was deployed, and the release.

endpoint-page.png

Error Handling

501 Not Implemented

The 501 Not Implemented error occurs when a request type other than POST is sent to the endpoint. In the context of the decision flow system, only POST requests are implemented, and any other request methods (such as GET, PUT, DELETE, etc.) will result in this error.

How to Resolve

To resolve the 501 Not Implemented error, ensure that the client or system communicating with the endpoint uses the POST method for sending requests. Here's a general outline of how to do so:

  1. Verify the request method being used in the client or system.

  2. If a method other than POST is being used, update the request to use the POST method.

  3. Ensure that the request payload and headers are properly formatted for a POST request, as per the endpoint's requirements.

  4. Resend the request.

By following these steps and using the POST method, the 501 Not Implemented error should no longer occur.

Execution Time Limit
Each request has a 300s max execution time. Requests exceeding this are terminated.