API reference

The full API reference will be auto-generated from our OpenAPI 3.1 spec the moment the surface is stable. We'd rather ship a placeholder than fake-doc endpoints that might still move. In the meantime, here's the shape, what it'll cover, and what to do today.

Form (kan endres)

REST over HTTPS. JSON inn, JSON ut. Bearer-token-auth på hver request. Versjonert i path: /v1/.... Rate-limited per token; responsen bærer de vanlige X-RateLimit-*-headerne.

curl

1# hvert endepunkt tar en API-nøkkel i Authorization-headeren2curl https://api.verbumia.ca/v1/projects \3  -H "Authorization: ApiKey vrb_live_<prefix>.<secret>" 5{ "data": [{ "id": "proj_xxx", "name": "Checkout", … }] }

API-nøkler kommer fra Org Settings → API Keys i dashbordet. Samme nøkkel fungerer for CLI-en, MCP-serveren og direkte REST-kall — API-en konsumerer bare beareren.

Ressurser ved lansering

Dette er ressursene V1-API-en vil eksponere. Den eksakte formen — felter, feilkoder, paginering — lander når vi publiserer OpenAPI-specen.

Ressurs	Hva den representerer	V1-ops
Projects	Workspaces. Opprett, list, arkiver, overfør ownership.	GET · POST · PATCH · DELETE
Locales	Prosjekt-scoped locale-sett. Legg til en locale, marker som default, aktiver/deaktiver for klienter.	GET · POST · PATCH · DELETE
Namespaces	Logiske bøtter av nøkler per prosjekt (f.eks. "checkout", "common").	GET · POST · PATCH · DELETE
Keys	Oversettelsesnøkler med beskrivelse, screenshot-URL-er, max-length, flertallsregler.	GET · POST · PATCH · DELETE
Translations	Verdi per locale for en nøkkel. Draft-, in-review-, approved-states; revisjonshistorikk.	GET · POST · PATCH · DELETE
Missing keys	Runtime-SDK-ens kø. List, grupper etter frekvens, marker som triagert.	GET · PATCH
Webhooks	Abonner på oversettelsesevents. V2.	V2

Hva du gjør i dag

Nesten alt du ville brukt API-en til er allerede eksponert via CLI-en, MCP-serveren eller runtime-SDK-en. Bruk dem — når API-en lander, kan koden din bytte til direkte HTTP-kall uten å endre hva den faktisk gjør.

CLI

@verbumia/cli

Push, pull, import, export — dekker de fleste automasjonsbehov.

MCP

Sett opp Claude Desktop

Les nøkler, foreslå oversettelser, gjennomgå PR-diffs fra hvilken som helst agent.

SDK

React + i18next

Les oversettelser og fang manglende nøkler i runtime.

Referanse

Alle docs

Indeks over alt vi har publisert så langt.

Live OpenAPI for early devs

Hvis du kjører Verbumia-backenden lokalt, eksponeres live OpenAPI 3.1-specen på:

lokal backend

http://localhost:8820/openapi.json

Pek Stoplight, Swagger UI, Insomnia, Postman eller hvilket som helst OpenAPI-bevisst verktøy på den URL-en. Formen flytter seg — derfor er denne siden en placeholder — men det er kilden til sannhet akkurat nå hvis du vil utforske endepunkter tidlig.

Når lander den offentlige referansen?

Den offentlige OpenAPI-specen vil serveres på https://api.verbumia.ca/openapi.json så snart V1-surface er frosset. Derfra bytter denne siden fra placeholder til en fullt rendret referanse (Stoplight eller lignende viewer over specen) — ingen markedsføringstekst, bare hvert endepunkt, hver payload, hver feilkode, generert fra kilden.