Get a repository's guidance
const url = 'https://zkao.io/api/v1/projects/example/repositories/example/guidance';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://zkao.io/api/v1/projects/example/repositories/example/guidance \ --header 'Authorization: Bearer <token>'Requires scope: read. Returns the per-repo guidance configured for this repository. Guidance is layered on top of any zkao.md committed in the repo at scan time; a per-scan guidance on launch replaces this layer for that one scan only.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Responses
Section titled “ Responses ”OK
object
The configured guidance, or null when none is set.
When the guidance last changed. Null when the repo has no revision history (guidance never set, or set before revisions were tracked).
Examplegenerated
{ "repositoryId": "example", "content": "example", "updatedAt": "2026-04-15T12:00:00Z"}Missing, malformed, expired, or revoked token
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}The token lacks the required scope
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}Resource not in this token’s project or repo allowlist
object
object
Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.
Example
{ "error": { "code": "unauthorized" }}