OpenAPI Compatible REST APIs

What are OpenAPI Compatible REST APIs?

OpenAPI (version 2.0 or 3.0, in JSON or YAML format) is an industry standard for documenting RESTful APIs. It provides:

• Clear API Definition: Endpoints, HTTP methods, input/output parameters, authentication methods, and expected responses are all precisely described.
• Interoperability: APIs described in OpenAPI format are easily discovered, consumed, and integrated across platforms and tools.

Why are OpenAPI REST APIs important for Agent-Building platforms?

• Fast Integration: Instantly connect to external or third-party REST APIs by uploading their OpenAPI specification—even if direct integration via an MCP isn’t available.
• Reusable Agent Tools: Convert OpenAPI-defined APIs into agent tools that your knowledge or data analysis agents can invoke during conversations.
• Easy API Management: Upload your OpenAPI (v2.0/v3.0 JSON), review and test endpoints, update descriptions, and refine parameter details to guide agent interactions.
• Accelerated development: Automated import and configuration of APIs reduces manual effort, helps prevent errors, and speeds up the development of agent capabilities.

Configure OAuth2 for your REST APIs

REST API Data sources support OAuth2. Add your preferred authentication method to use your REST APIs.

1. Select Data Sources in the left sidebar and select Add data source button.

2. Select REST API as the Source Type and optionally add a custom name and description for the data source under Advanced Configuration.

   

3. Upload your OpenAPI 2.0 or above specification JSON file to automatically configure API endpoints and select Add REST API source button.

4. On the Data Sources dashboard, select the REST APIs tab, then click the lock icon in the Actions column for that data source.

   

5. Authorize the REST API access to this data source by entering Client ID, Client Secret and OAuth2 Flow Type. Based on the flow type selected, a new selector will be displayed where you can select the desired scopes.

6. Select Request authorization button.

   

7. For the ‘Authorization Code’ flow type, you will be redirected to a page to grant the necessary permissions. After approving access, you will be sent to a callback page that displays “Authorization complete.” You can then close this tab and return to Agent Factory. When you see the message “Authorization successful. You can now access your secured endpoints.”, it means your authentication settings have been saved and you can begin using the REST API in Agent Builder.