code-anything.com
Log inStart free

Developer

Insight Docs

Insight Docs is a documentation framework dressed for engineers: a crisp light canvas, a developer-blue accent, and a three-pane layout that scales from a quickstart to a full API reference. A persistent sidebar handles navigation, a comfortably measured content column keeps long-form prose legible, and dark syntax-highlighted code blocks plus an "On this page" rail make scanning and copying effortless.

Crisp, calm, and engineer-friendly — documentation that gets out of the way.

dev-docs.code-anything.app
</>
Insight Docs
Search the docs/
v2.4
GitHub
Guides/Authentication

Authentication

POSThttps://api.insight.dev/v1/documents/searchSecret key

Every request to the Insight API must be authenticated with a secret key. Keys are scoped per project and carry the permissions you assign in the dashboard. Treat them like passwords — anyone with a key can read and write your data. See the quickstart to create your first project.

How signing works

The client SDK attaches your key as a bearer token on every call. When a request arrives, the gateway checks four things before it ever reaches your resources:

  • The key exists and is active — revoked keys return 401.
  • The key has the scope required by the endpoint (for example documents:write).
  • The request is within your per-minute rate limit.
  • The request body matches the declared content type.
Note  Keep your secret key on the server. Never embed it in client-side code or commit it to version control — use environment variables instead.

Make an authenticated request

Install the SDK and pass your key when you construct the client. The example below reads the key from the environment and searches your indexed documents.

app/search.tsCopy
import { Insight } from "@insight/sdk"

// read the key from the environment
const client = new Insight(process.env.INSIGHT_API_KEY)

const results = await client.documents.search({
  query: "billing webhooks",
  limit: 5,
})

console.log(results.hits.length)

A successful call returns a 200 with a list of ranked hits. If the key is missing or invalid you'll receive a structured error — see the errors reference for the full list of codes.

Endpoints

Responses

200OKRanked hits returned in data[]
401UnauthorizedMissing, revoked, or malformed key
403ForbiddenKey lacks the required scope
429Too Many RequestsPer-minute rate limit exceeded

Design rules

The system, applied to any site

Every rule below travels with the template — describe your tweaks and the agent keeps the system intact.

What it decides for you

  • Keep the canvas light and quiet: white content background with a faint blue-grey surface (#F7F9FC) for the sidebar and code chrome, and reserve the developer-blue accent for links, the active nav item, and focus states only.
  • Optimize prose for readability: constrain the content column to roughly a 70–75 character measure (~720px), set body text at 16px with 1.7 line-height, and give headings clear vertical rhythm with anchor links on hover.
  • Render code blocks on a dark slate background (#0F172A) with a monospace font, comfortable padding, a small language label, and a copy button; use restrained token colors and never wrap long lines silently — allow horizontal scroll.
  • Use a three-pane structure: a fixed left sidebar for navigation, a centered readable content column, and a slim right "On this page" TOC that highlights the section currently in view.
  • Lean on hairline borders (#E2E8F0) and small 8px radii instead of heavy shadows, and use monospace for inline code, endpoints, and keyboard hints to signal "this is technical" without shouting.

Ships with

Top bar with product mark and command-style searchLeft sidebar navigation with grouped sectionsReadable content column with headings and proseDark syntax-highlighted code samples with copyOn-this-page table of contentsCallout / admonition blocks (note, warning, tip)Previous / next page footer navigation

Design tokens

Palette

bg
surface
text
muted
accent
accent2
border

Headings

Inter

Body

Inter

Radius

8px

Explore palettes

Keep looking

More from the library

AuroraMarketing
Warm ArtisanMarketing
Sharp FadeBooking
CockpitDashboard

Make it yours in minutes.

Start from this template and describe your tweaks — content, sections, colours. The backend and deploy are handled.