API reference

Docs API

Retrieve and search AI-generated documentation across your connected repositories.

GET/api/v1/docsdocs:read

Returns a paginated list of AI-generated documentation entries accessible by the API key. Optionally filter by repository.

Parameters

Name	Type	Required	Description
`repo`	`string`	optional	Filter by repository full name, e.g. "acme/backend".
`limit`	`integer`	optional	Maximum number of results to return.Default: `50 (max 200)`
`offset`	`integer`	optional	Pagination offset.Default: `0`

Request

curl https://scopedocs-ai-production.up.railway.app/api/v1/docs \
  -H "X-API-Key: sk-sd_your_key_here"

Response

JSON

{
  "docs": [
    {
      "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
      "title": "Authentication Service Overview",
      "doc_type": "overview",
      "audience_type": "developer",
      "style": "technical",
      "repo_full_name": "acme/backend",
      "is_stale": false,
      "created_at": "2026-01-15T10:22:00Z",
      "updated_at": "2026-03-20T08:00:00Z"
    }
  ],
  "total": 47
}

GET/api/v1/docs/searchdocs:read

Performs vector similarity search over generated documentation. Returns the most semantically relevant docs for the query.

Parameters

Name	Type	Required	Description
`q`	`string`	required	The search query. Minimum 1 character.
`top_k`	`integer`	optional	Number of results to return.Default: `5 (max 20)`

Request

curl "https://scopedocs-ai-production.up.railway.app/api/v1/docs/search?q=authentication&top_k=5" \
  -H "X-API-Key: sk-sd_your_key_here"

Response

JSON

{
  "results": [
    {
      "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
      "title": "Authentication Service Overview",
      "similarity": 0.91,
      "excerpt": "The authentication service handles JWT issuance and validation. It supports OAuth 2.0 flows for GitHub, Slack, and Linear integrations...",
      "repo_full_name": "acme/backend"
    }
  ]
}

GET/api/v1/docs/{doc_id}docs:read

Retrieves the full content of a single generated documentation entry by its ID.

Parameters

Name	Type	Required	Description
`doc_id`	`string`	required	The UUID of the documentation entry.

Request

curl https://scopedocs-ai-production.up.railway.app/api/v1/docs/d1a2b3c4-e5f6-7890-abcd-ef1234567890 \
  -H "X-API-Key: sk-sd_your_key_here"

Response

JSON

{
  "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "repo_full_name": "acme/backend",
  "doc_type": "overview",
  "audience_type": "developer",
  "style": "technical",
  "title": "Authentication Service Overview",
  "content": "# Authentication Service Overview\n\nThe authentication service handles JWT issuance...",
  "references": {
    "github_prs": [
      "acme/backend#42"
    ],
    "linear_issues": [
      "ENG-101"
    ]
  },
  "is_stale": false,
  "file_path": null,
  "created_at": "2026-01-15T10:22:00Z",
  "updated_at": "2026-03-20T08:00:00Z"
}