API

An API source holds documents that you send to Raffle yourself, from your own systems, instead of having Raffle crawl them. You decide what goes in and when it changes.

Create an API source

1. Go to Sources and click Add new source
2. Select API and click Next
3. Enter a Source Title, and under Privacy Settings choose whether the content is Internal or Public
4. Click Create

Raffle then opens the source’s API Source - Quickstart page.

The quickstart page

The quickstart page has what you need to start pushing documents:

• the Base Route, https://api.raffle.ai/v2/sources/
• the Source UID, which goes in every request
• the endpoints to list, add or update, and delete documents, with the document schema and the errors you can get

To open it later, open the source on the Sources page and click View Docs, or Setup API Source above the list of documents.

Every request needs an API key in the X-API-Key header. Click Open API Keys to create one; the key is shown only once, so copy it straight away. Creating API keys needs the Account Admin role.

For the full guide, with examples, see API Index.