Create API Tools

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

What is an API tool?

An API tool gives you direct programmatic access to Raffle’s search capabilities — without a hosted widget. 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 tool

Navigate to Tools and click Create new Tool.

When prompted to choose a tool type, select API.

Choose the API option

Give the tool a name and connect the data sources (indexes) you want it to search. The setup follows the same flow as for a widget — see Create a Widget for a detailed walkthrough.

Find your tool UID

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

Click the Go Live button in the upper right corner of your tool’s admin page. The UID appears in the script snippet and can be copied from there.

Next steps

  • Use the search API: Query your tool 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