API Documentation · API 文檔 · API 文档 · API ドキュメント

RaySearch

RaySearch is an async-first search orchestration engine for AI-overview style workflows. It can be used as:

• a Python package with Engine
• a personal HTTP API service
• a Docker or Docker Compose deployment

Core Capabilities

• search: multi-provider retrieval with optional fetch and rerank stages
• fetch: page crawling, extraction, abstracts, overview generation, and related links
• answer: grounded answer generation with citations
• research: multi-round research reports with synthesis and structured output

Start With Docker Compose

git clone https://github.com/radiata-labs/raysearch.git
cd raysearch/docker
cp .env.example .env

Then edit .env with your own values. At minimum:

• set RAYSEARCH_API_KEY
• set OPENAI_API_KEY if you want answer, research, or LLM-powered overview features

Start the service:

docker compose up -d

For development with hot reload:

docker compose -f docker-compose.yml -f docker-compose.override.yml up

The compose setup reads:

• environment from docker/.env
• service config from docker/raysearch.example.yaml

If you want a separate config file, copy docker/raysearch.example.yaml and point RAYSEARCH_CONFIG_FILE to it in .env.

Start With uv

From the repository root:

uv run --extra service --env-file docker/.env raysearch-api --config docker/raysearch.example.yaml

Or from inside the docker directory:

uv run --project .. --extra service --env-file .env raysearch-api --config raysearch.example.yaml

Python Package Usage

from raysearch import Engine, SearchRequest

async def main() -> None:
    async with Engine.from_settings("docker/raysearch.example.yaml") as engine:
        response = await engine.search(
            SearchRequest(
                query="latest multimodal model papers",
                user_location="US",
                mode="deep",
                max_results=8,
                fetchs={"content": True},
            )
        )
        print(response.results)

Personal API

The personal API exposes:

• GET /healthz
• POST /v1/search
• POST /v1/fetch
• POST /v1/answer
• POST /v1/research

It uses one shared static bearer token from api.bearer_token or RAYSEARCH_API_KEY. This service is intended for a single user or a private trusted environment.