Agentic Search

Prerequisites

Sign up for a Relace account.
Create an API key.
Connect to the Relace GitHub App.

Import GitHub Project

We’ll start by creating a new Relace Repo using GitHub as a source. We use GitHub as an easy example, but agentic search will work over any Relace Repo.

import { Relace } from "@relace-ai/relace";

const client = new Relace({ apiKey: "YOUR_API_KEY" });

const repo = await client.repo.create({
    source: {
        type: "git",
        url: "https://github.com/relace-ai/vite-template",
        branch: "main"
    }
});

const repoId = repo.repo_id;
console.log(`Repository created with ID: ${repoId}`);

Perform Agentic Search

You can now use the search endpoint to find relevant files based on a query in natural language!

import { Relace } from "@relace-ai/relace";

const client = new Relace({ apiKey: "YOUR_API_KEY" });

const results = await client.repo.search(repoId, {
    query: "Add a user profile component with avatar and edit functionality"
});

for await (const event of results) {
    console.log(event);
}

The response will be a stream of Server-Sent Events with real-time updates as the agent explores the repo. The final report_back event provides an explanation of the findings and the relevant files with line ranges.

{
  "name": "report_back",
  "explanation": "The user profile components live in src/components/UserProfile.tsx, with shared types in src/types/user.ts. ...",
  "files": {
    "src/components/UserProfile.tsx": [[1, 120]],
    "src/types/user.ts": [[1, 40]]
  }
}

For more details, see our API reference.

⌘I

Getting Started

Model Guides

Repos

Agents

Agentic Search

Prerequisites

​Prerequisites

Prerequisites