API Overview

Code Search provides a comprehensive REST API for integrating search into your workflows.

Base URL

http://localhost:8080/api/v1

Or for production:

https://your-code-search-domain.com/api/v1

Authentication

Currently, the API does not require authentication for local deployments. For production deployments, Bearer token authentication can be configured.

API Endpoints

Search

Search across all indexed repositories POST /api/v1/search

Repositories

List and manage repositories GET /api/v1/repos

Connections

Manage code host connections GET /api/v1/connections

Jobs

Monitor background jobs GET /api/v1/jobs

SCIP

Precise code intelligence (go-to-definition, find-references) POST /api/v1/scip/repos/{id}/definition

Replace

Search and replace across repositories POST /api/v1/replace/execute

Request Format

All requests should include:

Content-Type: application/json
Accept: application/json

Response Format

All responses are JSON. The format varies by endpoint:

Success Response (Search)

{
  "results": [...],
  "total_count": 100,
  "duration": "15ms",
  "stats": {
    "files_searched": 1234,
    "repos_searched": 45
  }
}

Success Response (List)

{
  "repos": [...],
  "total_count": 50
}

Error Response

{
  "error": "Invalid query parameter"
}

Or plain text error message with appropriate HTTP status code.

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad request
401	Unauthorized
404	Not found
500	Server error

Pagination

List endpoints support pagination using limit and offset:

GET /api/v1/jobs?limit=50&offset=100

Response includes pagination metadata:

{
  "jobs": [...],
  "total_count": 150,
  "limit": 50,
  "offset": 100,
  "has_more": false
}

Timeouts

API requests have the following timeout limits:

Operation	Timeout
Read	15s
Write	60s

Examples

cURL

# Search (POST request with JSON body)
curl -X POST "http://localhost:8080/api/v1/search" \
  -H "Content-Type: application/json" \
  -d '{"query": "handleRequest"}'

# List repos
curl "http://localhost:8080/api/v1/repos"

# List jobs with filters
curl "http://localhost:8080/api/v1/jobs?status=running&type=index"

JavaScript

// Search (POST request)
const response = await fetch("http://localhost:8080/api/v1/search", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ query: "handleRequest" }),
});
const data = await response.json();
console.log(data.results);

Python

import requests

response = requests.post(
    'http://localhost:8080/api/v1/search',
    json={'query': 'handleRequest'}
)
data = response.json()
print(data['results'])

Go

payload := map[string]string{"query": "handleRequest"}
body, _ := json.Marshal(payload)

resp, err := http.Post(
    "http://localhost:8080/api/v1/search",
    "application/json",
    bytes.NewBuffer(body),
)
if err != nil {
    log.Fatal(err)
}
defer resp.Body.Close()

var result SearchResponse
json.NewDecoder(resp.Body).Decode(&result)

OpenAPI Specification & Interactive Docs

Code Search provides a complete OpenAPI 3.1 specification and interactive Swagger UI:

Resource	URL	Description
Swagger UI	/docs	Interactive API explorer
OpenAPI Spec	/openapi.yaml	Full API specification (YAML)
OpenAPI JSON	/openapi.json	Redirects to YAML

Tip

The Swagger UI at /docs is the best way to explore and test the API. It shows all endpoints, request/response schemas, and lets you try API calls directly.

You can import the OpenAPI spec into tools like Postman, generate client SDKs, or use code generators.

API Categories

Category	Description
Search	Code search across repositories
Repositories	Repository CRUD and management
File Browsing	Browse files, directories, branches (can be disabled)
Connections	Code host connection management
Replace	Search & replace with MR creation
Symbols	Find definitions and references
Jobs	Background job monitoring
Scheduler	Sync scheduler management
Health	Liveness and readiness probes

SDKs

Official SDKs are planned for:

• Go
• TypeScript/JavaScript
• Python

Next Steps

• Search API - Search endpoints
• Repositories API - Repository endpoints
• Connections API - Connection endpoints