Skip to main content

​
Quick Start

This guide will help you get Ground up and running with your first indexed source.

​
1. Get an API Key

Sign up at app.trygroundai.com to get your API key. Send it on every request using Authorization: Bearer gnd_… or X-API-Key: gnd_…. 
export GROUND_API_KEY="gnd_your_api_key"

​
2. Add Your First Source

Ground can index Git repositories, documentation sites, and packages (npm/PyPI).

​
Via UI

  1. Navigate to Sources → Add Source in the Dashboard
  2. Select source type (Repository, Documentation, or Package)
  3. Enter the URL and configuration
  4. Click Create

​
Via API

# Add a Git repository
curl -X POST https://api.trygroundai.com/sources \
  -H "Authorization: Bearer $GROUND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Repo",
    "source_type": "repo",
    "url": "https://github.com/groundai/ground",
    "branch": "main"
  }'

​
3. Sync the Source

Once created, tell Ground to start indexing your content. 
# Replace SOURCE_ID with the ID from the create response
curl -X POST https://api.trygroundai.com/sources/SOURCE_ID/sync \
  -H "Authorization: Bearer $GROUND_API_KEY"
Or click Sync in the Dashboard.

​
4. Search Your Content

As soon as the sync job finishes (or while it’s in progress), you can start querying your grounded context.

​
Via UI

Navigate to the Playground in the Dashboard and enter a search query.

​
Via API

curl "https://api.trygroundai.com/search?query=how+to+authenticate" \
  -H "Authorization: Bearer $GROUND_API_KEY"

​
Next Steps

Concepts

Learn about sources, jobs, citations, and freshness

SDKs

Integrate Ground into your app using our official SDKs

Trust Policy

Configure staleness budgets and refusal thresholds

API Reference

Complete API documentation