Skip to main content
Call your Raily endpoint from your own code — a backend service or an agent you build — with a typed client. Install it, add your key, and run a search.

Python

pip install raily-ai

TypeScript / JavaScript

npm install @raily/sdk

Get your endpoint URL and key

An endpoint is your authenticated search URL — create one in the Raily app. It needs two things to call: the endpoint URL and an API key.
1

Open an endpoint

In the Raily app, open an endpoint (or create one). Its page shows the endpoint URL.
2

Create an API key

Under API access, click Create key. The full key is shown once — copy it now.
3

Set them in your environment

Keep the key out of source control — load it from an environment variable.
Output
Each result’s content lives in fields — a flat {name: value} map of the display fields configured on your source (e.g. title, text, author, published_date). See Reading results.

Reading results

search() returns a list of results. Each has a score, the source_collection it came from, and fields — a flat map of your source’s display fields. Read a value by name, or walk the whole map to see what your source exposes:

Next steps

Python SDK

Reference, async, errors, recipes

TypeScript SDK

Reference, errors, recipes