Create an API widget

Set up an API widget to integrate Raffle’s AI search capabilities directly into your own applications or AI platforms.

What is an API widget?

An API widget gives you direct programmatic access to Raffle’s search capabilities, without a visual widget on your page. Instead of embedding a UI component on your website, you query Raffle from your own application, or connect it to an AI platform like Claude or MS Copilot via MCP.

Create an API widget

  1. Go to Widgets and click Add new widget
  2. Under Select a type, choose API and click Next
Choose the API type

Choose the API type

  1. Under Choose how to use your widget, select Search. API widgets are search-only.
  2. Give the widget a name and choose its sources, then click Complete.

These steps work as for a widget; see Create a Widget for details. The widget then appears in the Widgets list. Its settings are described under API widgets.

Find your widget UID

The UID is required to call the API and to set up the MCP server.

Open the widget and click Install at the top right, or click ⋯ next to it on the Widgets page and choose Install. The Install API dialog shows:

  • the widget’s UID: click Copy UID;
  • the widget’s MCP URL: click Copy URL to connect it to an AI assistant.

Next steps

  • Use the search API: Query your widget programmatically from your application. See the API documentation for endpoints and parameters.
  • Connect to an AI platform via MCP: Expose your Raffle search as a tool in Claude, MS Copilot, or any other MCP-compatible AI assistant. See the MCP Server guide.

Next Page

Chat