Skip to content

docs: fix authentication header from Authorization: Bearer to X-API-KEY #565

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philwinder wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix authentication header from Authorization: Bearer to X-API-KEY #565

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67c4b1d
docs: add missing service package import to Go library example
May 10, 2026
1f6070c
docs: fix authentication header from Authorization: Bearer to X-API-KEY
May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,10 @@ The enrichment tools (`architecture_docs`, `api_docs`, `database_schema`, `cookb
Kodit can be embedded directly as a Go library. This is how [Helix](https://helix.ml) integrates Kodit into its platform.

```go
import "github.com/helixml/kodit"
import (
"github.com/helixml/kodit"
"github.com/helixml/kodit/application/service"
)

client, err := kodit.New(
kodit.WithSQLite(".kodit/data.db"),
Expand Down Expand Up @@ -400,7 +403,7 @@ spec:

### Authentication

Set the `API_KEYS` environment variable to a comma-separated list of keys. Write endpoints (creating repositories, triggering syncs) require a valid key in the `Authorization: Bearer <key>` header. Search endpoints are open by default.
Set the `API_KEYS` environment variable to a comma-separated list of keys. Write endpoints (creating repositories, triggering syncs) require a valid key in the `X-API-KEY: <key>` header. Search endpoints are open by default.

## Configuration Reference

Expand Down Expand Up @@ -549,7 +552,7 @@ Key endpoints:
| `GET` | `/api/v1/search/grep` | Regex pattern search |
| `GET` | `/api/v1/search/ls` | List files by glob |

All write endpoints require an `Authorization: Bearer <key>` header when `API_KEYS` is set.
All write endpoints require an `X-API-KEY: <key>` header when `API_KEYS` is set.

## How Indexing Works

Expand Down
Loading