Facebook Youtube Linkedin-in Envelope
Consult Us

Unlock External Integrations with
Oracle AI Studio’s External REST Tool

Unlock External Integrations with Oracle AI Studio’s External REST Tool

Oracle AI Studio’s External REST Tool empowers AI Agents to securely interact with external systems via REST APIs – all from within the native Oracle environment.
The tool offers a simple and powerful way to configure REST-based integrations and allows AI Agents to dynamically invoke external services as part of their workflow.

Provide a Specific REST Endpoint to Create a Connection

The first step is to configure a REST connection that the AI Agent can use.

How it works:

  • Set up the Resource Path, HTTP/S operation, and parameters for each Function exposed within the tool.
  • Example
  • Tool Name: Get Purchase Order
  • Key: GET_PURCHASE_ORDER
  • Category: SCM
  • Description: “This tool can check the Purchase Order Details with PO_HEADER_ID.”
  • Why it matters
  • This defines how the AI Agent will interact with the REST endpoint, what method it will use (GET/POST), and what it expects in return.

Setup Parameters

Purpose

Define slottable parameters for headers, query parameters, and body for each Function. The tool allows designers to add parameters that will be used when the Agent makes REST calls. In this example, the Function is ready to accept PO Details values as part of the REST request.

Why it matters

Parameters make the Function dynamic allowing the AI Agent to pass different values (like different locations in this case) based on user queries.

Show Sample Queries to the LLM

Purpose

Give examples of the query so the LLM (Large Language Model) can properly slot parameters for that call.

  • Example shown:
  • Sample Query: /fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}
  • Description: “Sample query that needs Purchase Order Details.”

Why it matters:

The LLM learns how to generate queries for this REST call by seeing examples. This ensures the AI Agent can dynamically construct correct calls during runtime.

Test the Functions from Within AI Agent Studio

Purpose:

Test each Function at design time, by creating example parameters to ensure the Function is defined correctly and works within the Oracle environment. The Function Get Purchase Order is ready to be tested by the designer using the UI in AI Agent Studio. The test ensures that the endpoint returns the expected Purchase Order details.

Why it matters:

Testing Functions before deploying them guarantees that Agents won’t encounter errors when using these integrations in production.

Create the External REST Tool and Provide to an Agent to Execute the REST Call

Purpose:

Describe the capabilities of the tool, along with the Function definitions, to enable the AI Agents to execute those calls when needed.

  • Workflow
  • Once the tool and Function are validated, they are made available to the Agents.
  • When user queries match the Function (e.g. “What’s the Total PO Count Today?”), the Agent will invoke this REST Function using the correct parameters.
  • The Get Purchase Order tool is now ready for AI Agents to use for REST calls to retrieve weather data.

On-Screen Fields Summary

Field 

Example Value 

Tool Type 

External REST 

Tool Name 

Get Purchase Order 

Key 

GET_PURCHASE ORDER 

Category 

SCM 

Description 

This tool can check the local weather by a latitude/longitude point 

Method 

GET 

Sample Query 

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID} 

Sample Query Description 

Sample query that needs a latitude, longitude pair to provide weather for that location 

 

Final Word

Oracle AI Studio’s External REST Tool makes it effortless to bring external data and services into AI-powered conversations:

  • Define REST endpoints
  • Configure parameters dynamically
  • Provide examples for LLM learning
  • Test REST calls within Oracle AI Studio
  • Enable AI Agents to invoke these APIs at runtime
Rapidflow is a leading implementation partner for Oracle On-premise and Cloud technologies.
Facebook-f Twitter Tumblr

Links

Public Security

Mineral Explore

Aerial Photography

Movie Production

Support

Help Center

Ticket

FAQ

Contact

Community

Support

Help Center

Ticket

FAQ

Contact

Community

Explore Rapidflow AI

An accelerator for your AI journey

View Page