Search result fields
A successfulPOST /v1/search response has this shape:
{
"request_id": "req_a1b2c3d4e5f6",
"results": [
{
"rank": 1,
"repo": "marmelab/react-admin",
"url": "https://github.com/marmelab/react-admin",
"score": 0.97,
"summary": "A frontend framework for building B2B applications on top of REST/GraphQL APIs, using React.",
"stars": 24000,
"forks": 5300,
"license": "MIT"
}
]
}
Top-level fields
| Field | Type | Meaning |
|---|---|---|
request_id | string | Request identifier. Include it when reporting issues. Matches X-Request-Id. |
results | array | Ranked repository results. Can be empty. |
results[]
| Field | Type | Meaning |
|---|---|---|
rank | integer | 1-based position in the response. |
repo | string | GitHub full name in owner/name format. |
url | string | GitHub repository URL. |
score | number | Relevance score for this query. Compare within one response. |
summary | string or null | AI-generated or indexed repo summary when available. |
stars | integer | GitHub stars at indexing time. |
forks | integer | GitHub forks at indexing time. |
license | string or null | SPDX license identifier when detected. |