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.

Use this template All templates

dev-docs.code-anything.app

</>

Insight Docs

Search the docs/

v2.4

GitHub

Guides/Authentication

Authentication

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.

PreviousQuickstart NextRate limits

Design rules

The system, applied to any site

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

surface

text

muted

accent

accent2

border

Headings

Inter

Body

Inter

Radius

8px

Explore palettes

More from the library

Aurora

New · Aurora 3.0 is here

Launch your product before the coffee cools

Aurora is the deploy-to-insight platform that turns a half-baked idea into a production-grade app — complete with hosting, analytics, and guardrails — without a single config file.

Start free Book a demo

No credit card required · Free for 14 days · Cancel anytime

app.aurora.dev/overview

Overview

Deployments

Analytics

Logs

Team

Settings

Requests

1.24M

+12.4%

Avg latency

38ms

-6.1%

Error rate

0.02%

-0.3%

Traffic this weekLast 7 days

Trusted by fast-moving teams worldwide

NimbusForgeworksLumeraStacklineQuantaVireo

Everything you need to ship with confidence

One platform that handles the unglamorous parts so your team can stay focused on the product.

Instant deploys

Push a branch and watch it go live in seconds. No pipelines to babysit, no surprise cold starts.

Built-in guardrails

SOC 2 controls, granular roles, and audit trails ship on by default so security never slows the team down.

Live insights

Real-time dashboards turn raw events into decisions, with alerts that reach the right person automatically.

99.99%

Uptime across all regions

40ms

Median edge response time

12k+

Teams shipping with Aurora

Simple pricing that grows with you

Start free and only pay when your product takes off. No hidden fees, ever.

Starter

$0/mo

For side projects finding their footing.

1 project

Community support

10k monthly events

Shared edge regions

Get started

Growth

$28/mo

For teams scaling toward product-market fit.

Unlimited projects

Priority support

5M monthly events

Custom domains & roles

Get started

Scale

Custom

For organizations with serious throughput.

Dedicated capacity

24/7 SLA & onboarding

Unlimited events

SSO & audit exports

Contact sales

Ready to ship your next big thing?

Join thousands of builders who launched faster with Aurora. Your first project is on us.

Start free today

AuroraMarketing

Baked fresh every sunrise

Warm bread, slow mornings, a kinder kind of breakfast.

A small neighborhood bakery turning honest flour, patient time and a hot oven into crusty loaves, buttery pastries and the best excuse to leave the house early.

Order ahead See today’s bakes

Today: Country Loaf

Stone-milled flour, 24-hour rise. Out of the oven at 7am.

Today’s bakes

A short, ever-changing list. When it’s gone, it’s gone.

Stone Country Loaf

Stone-milled wheat, 24-hour cold rise, blistered crust.

Brown-Butter Croissant

Laminated by hand, folded thirty-six times, shatteringly flaky.

Honey Rye Bun

Dark rye crumb, wildflower honey glaze, toasted caraway.

Our story

“We started with one borrowed oven, a sack of flour, and the stubborn belief that bread tastes better when nobody’s in a hurry.”

Eight years on, we still mix every dough by hand, still proof it overnight, and still sell out by noon most days. Flour & Ember is run by the same two bakers who opened it — you’ll usually find us dusted in flour behind the counter.

— Mara & Tomás, founders & head bakers

Come visit us

Hours

Tue – Fri7:00 – 15:00

Saturday7:00 – 16:00

Sunday8:00 – 14:00

MondayResting the ovens

Find us

Address14 Maple Row

NeighborhoodOld Mill Quarter

CityBrookhaven, OR

ParkingFree on Cedar St.

Say hello

Phone(503) 555-0148

Emailhello@flourandember.co

PickupOrder by 4pm prior

CateringAvailable weekdays

Reserve your loaf before we sell out

Place an order the night before and we’ll set aside something warm with your name on it. Whole loaves, pastry boxes and morning coffee for the table.

Warm ArtisanMarketing

Sharp Fade

Est. 2009 · Downtown Grooming

Walk In Sharp.
Walk Out Unmistakable.

Master barbers, straight-razor shaves and fades dialled to the millimetre. No guesswork, no fuss — just a chair, a mirror and a finish you will keep coming back for.

Book An Appointment See The Menu

The Price List