ScopeDocs
App

Getting started

Quick Start

Get up and running with the ScopeDocs API in minutes. You'll make your first authenticated request and retrieve generated documentation from your workspace.

Step 1: Create an API Key

Go to Settings → Organization and create a key in the API Key Management section with the docs:read scope. Copy the key — it's shown only once.

Note:

Only organization owners can create API keys. If you don't see the Organization settings or API Key Management section, ask your org owner.

Step 2: Make Your First Call

List the generated documentation in your workspace:

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

You'll get back a paginated list of docs with metadata like title, type, and repo.

Step 3: Search Documentation

Use vector search to find semantically relevant docs:

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

Results are ranked by cosine similarity (0–1). A score above 0.8 indicates a strong match.

Next Steps