Inkline
Menu

API reference

The Inkline REST API, v1. JSON in and out, errors as RFC 9457 problem details with a stable code. Generated from the API's own OpenAPI document, so it always matches what is deployed.

  • Base URL: set INKLINE_API to your API address (local development: http://localhost:5080).
  • Authentication: Authorization: Bearer ink_…. Create a personal API token in Settings → Tokens; it is shown once.
  • Limits: render 60 requests a minute per user; sign-in endpoints 30 a minute per IP. Over the limit you get 429 with Retry-After.

Render

Draw .ink text to SVG, PNG, JPEG, WebP or PDF with a personal API token.

POST/v1/render

Render .ink source to svg/png/jpeg/webp/pdf (same body as the web render route).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
sourcestringbodyyes
formatstringbodyyes
scalenumberbodyno
themestringbodyno
backgroundstringbodyno
paddingintegerbodyno

Responses: 200 OK · 400 Bad Request · 401 Unauthorized · 422 Unprocessable Entity · 429 Too Many Requests · 502 Bad Gateway

curl
curl -X POST "$INKLINE_API/v1/render" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{"source":"diagram flow \"Hi\"\n  start a \"Start\"\n  end b \"Done\"\n  a -> b","format":"png","scale":2}' \
  --output diagram.png

Diagrams

Create, list, search, rename and move diagrams; every save is a version.

GET/workspaces/{wid}/diagrams

Newest first. q = full-text (prefix) search over title and current source. Cursor paginated.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
FolderIduuidqueryno
Qstringqueryno
Cursorstringqueryno
Limitintegerqueryno

Responses: 200 OK · 400 Bad Request · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}/diagrams" \
  -H "Authorization: Bearer ink_…"

POST/workspaces/{wid}/diagrams

Create a diagram (version 1). Editor+.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
titlestringbodyyes
typestringbodyyes
sourcestringbodyyes
folderIduuidbodyno
engineVersionstringbodyno

Responses: 201 Created · 400 Bad Request · 403 Forbidden · 404 Not Found

curl
curl -X POST "$INKLINE_API/workspaces/{wid}/diagrams" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"<title>","type":"<type>","source":"diagram flow \"Hi\"\n  start a \"Start\"\n  end b \"Done\"\n  a -> b"}'

GET/diagrams/{id}

Diagram with current source; ETag: "<version>".

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/diagrams/{id}" \
  -H "Authorization: Bearer ink_…"

PATCH/diagrams/{id}

Rename and/or move (folderId: null moves to root; omit to keep). Editor+.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes
titlestringbodyno
folderIduuidbodyno

Responses: 200 OK · 400 Bad Request · 403 Forbidden · 404 Not Found · 409 Conflict

curl
curl -X PATCH "$INKLINE_API/diagrams/{id}" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/diagrams/{id}

Soft delete (restorable). Editor+.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes

Responses: 204 No Content · 403 Forbidden · 404 Not Found

curl
curl -X DELETE "$INKLINE_API/diagrams/{id}" \
  -H "Authorization: Bearer ink_…"

POST/diagrams/{id}/restore

Undo a soft delete. Editor+.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X POST "$INKLINE_API/diagrams/{id}/restore" \
  -H "Authorization: Bearer ink_…"

GET/diagrams/{id}/versions

Version history, newest first (without source).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/diagrams/{id}/versions" \
  -H "Authorization: Bearer ink_…"

POST/diagrams/{id}/versions

Append a version. Requires If-Match: "<current version>" (428 if missing, 412 if stale).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes
If-Matchstringheaderno
sourcestringbodyyes
engineVersionstringbodyno

Responses: 201 Created · 400 Bad Request · 412 Precondition Failed · 428 Precondition Required

curl
curl -X POST "$INKLINE_API/diagrams/{id}/versions" \
  -H "Authorization: Bearer ink_…" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/json" \
  -d '{"source":"diagram flow \"Hi\"\n  start a \"Start\"\n  end b \"Done\"\n  a -> b"}'

GET/diagrams/{id}/versions/{n}

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes
nintegerpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/diagrams/{id}/versions/{n}" \
  -H "Authorization: Bearer ink_…"

POST/diagrams/{id}/versions/{n}/restore

Create a new version whose source copies version n.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes
nintegerpathyes

Responses: 201 Created · 404 Not Found

curl
curl -X POST "$INKLINE_API/diagrams/{id}/versions/{n}/restore" \
  -H "Authorization: Bearer ink_…"

Sharing

Public view or comment links, and the anonymous read of a shared diagram.

GET/public/{token}

Anonymous view of a shared diagram. Revoked/expired/unknown → 404.

No authentication

NameTypeInRequired
tokenstringpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/public/{token}"

POST/diagrams/{id}/share-links

Create a public link; token and url are returned once. Editor+.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
iduuidpathyes
accessShareAccessbodyyes
expiresAtstringbodyno

Responses: 201 Created · 400 Bad Request

curl
curl -X POST "$INKLINE_API/diagrams/{id}/share-links" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{"access":"<access>"}'

Icons

Custom SVG or PNG icons per workspace, used as use=custom/<name>.

GET/workspaces/{wid}/icons

Custom icons of the workspace (any member), ordered by name.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}/icons" \
  -H "Authorization: Bearer ink_…"

POST/workspaces/{wid}/icons

Upload an icon (editor+): multipart 'file' (SVG ≤ 64 KB or PNG ≤ 256 KB) and 'name' ([a-z0-9-]{1,40}). SVG is sanitised; unsafe SVG is rejected.

Bearer token: a personal API token (ink_…) or a signed-in session

Body: multipart/form-data with name and file.

NameTypeInRequired
widuuidpathyes

Responses: 201 Created · 400 Bad Request · 403 Forbidden · 404 Not Found · 409 Conflict · 413 Payload Too Large

curl
curl -X POST "$INKLINE_API/workspaces/{wid}/icons" \
  -H "Authorization: Bearer ink_…" \
  -F name=my-icon -F file=@icon.svg

GET/workspaces/{wid}/icons/{id}/content

The icon file with its own Content-Type, a 'default-src none' CSP and nosniff (any member).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
iduuidpathyes

Responses: 200 OK · 304 Not Modified · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}/icons/{id}/content" \
  -H "Authorization: Bearer ink_…"

DELETE/workspaces/{wid}/icons/{id}

Delete an icon (editor+). Diagrams that use it fall back to the kind glyph (INK2018).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
iduuidpathyes

Responses: 204 No Content · 403 Forbidden · 404 Not Found

curl
curl -X DELETE "$INKLINE_API/workspaces/{wid}/icons/{id}" \
  -H "Authorization: Bearer ink_…"

Folders

A flat list of folders with parentId; at most five levels deep.

GET/workspaces/{wid}/folders

All folders in the workspace (flat; build the tree from parentId).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}/folders" \
  -H "Authorization: Bearer ink_…"

POST/workspaces/{wid}/folders

Create a folder (editor+). Max depth 5.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
namestringbodyyes
parentIduuidbodyno

Responses: 201 Created · 400 Bad Request · 403 Forbidden

curl
curl -X POST "$INKLINE_API/workspaces/{wid}/folders" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

PATCH/workspaces/{wid}/folders/{id}

Rename and/or move (parentId: null moves to root; omit to keep).

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
iduuidpathyes
namestringbodyno
parentIduuidbodyno

Responses: 200 OK · 400 Bad Request · 403 Forbidden · 404 Not Found

curl
curl -X PATCH "$INKLINE_API/workspaces/{wid}/folders/{id}" \
  -H "Authorization: Bearer ink_…" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/workspaces/{wid}/folders/{id}

Delete a folder and its sub-folders; their diagrams move to the root.

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes
iduuidpathyes

Responses: 204 No Content · 403 Forbidden · 404 Not Found

curl
curl -X DELETE "$INKLINE_API/workspaces/{wid}/folders/{id}" \
  -H "Authorization: Bearer ink_…"

Workspaces

Your personal workspace and team workspaces.

GET/workspaces

Workspaces the caller belongs to (personal first) with the caller's role.

Bearer token: a personal API token (ink_…) or a signed-in session

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/workspaces" \
  -H "Authorization: Bearer ink_…"

POST/workspaces

Create a team workspace; the caller becomes owner.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
namestringbodyyes
slugstringbodyno

Responses: 201 Created · 400 Bad Request · 409 Conflict

curl
curl -X POST "$INKLINE_API/workspaces" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

GET/workspaces/{wid}

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}" \
  -H "Authorization: Bearer ink_…"

PATCH/workspaces/{wid}

Rename (owner only).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
widuuidpathyes
namestringbodyyes

Responses: 200 OK · 400 Bad Request · 403 Forbidden · 404 Not Found

curl
curl -X PATCH "$INKLINE_API/workspaces/{wid}" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

DELETE/workspaces/{wid}

Delete a team workspace and its content (owner only; personal workspaces cannot be deleted).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
widuuidpathyes

Responses: 204 No Content · 403 Forbidden · 409 Conflict

curl
curl -X DELETE "$INKLINE_API/workspaces/{wid}" \
  -H "Authorization: Bearer <access token from sign-in>"

Members

Who can view, comment, edit or own a workspace.

GET/workspaces/{wid}/members

Bearer token: a personal API token (ink_…) or a signed-in session

NameTypeInRequired
widuuidpathyes

Responses: 200 OK · 404 Not Found

curl
curl -X GET "$INKLINE_API/workspaces/{wid}/members" \
  -H "Authorization: Bearer ink_…"

POST/workspaces/{wid}/members

Add a user by email (owner only). Always 202 {} whether or not the email has an account or is already a member (no account enumeration).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
widuuidpathyes
emailstringbodyyes
roleWorkspaceRolebodyyes

Responses: 202 Accepted · 400 Bad Request · 403 Forbidden · 404 Not Found

curl
curl -X POST "$INKLINE_API/workspaces/{wid}/members" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>","role":"<role>"}'

PATCH/workspaces/{wid}/members/{userId}

Change a member's role (owner only; the last owner cannot be demoted).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
widuuidpathyes
userIduuidpathyes
roleWorkspaceRolebodyyes

Responses: 200 OK · 400 Bad Request · 403 Forbidden · 409 Conflict

curl
curl -X PATCH "$INKLINE_API/workspaces/{wid}/members/{userId}" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"role":"<role>"}'

DELETE/workspaces/{wid}/members/{userId}

Remove a member (owner), or leave (yourself).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
widuuidpathyes
userIduuidpathyes

Responses: 204 No Content · 403 Forbidden · 409 Conflict

curl
curl -X DELETE "$INKLINE_API/workspaces/{wid}/members/{userId}" \
  -H "Authorization: Bearer <access token from sign-in>"

Me

Your profile and personal API tokens.

GET/me

The signed-in user (JWT or API token).

Bearer token: a personal API token (ink_…) or a signed-in session

Responses: 200 OK · 401 Unauthorized

curl
curl -X GET "$INKLINE_API/me" \
  -H "Authorization: Bearer ink_…"

PATCH/me

Update display name and/or locale.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
displayNamestringbodyno
localestringbodyno

Responses: 200 OK · 400 Bad Request

curl
curl -X PATCH "$INKLINE_API/me" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/me/tokens

Active personal API tokens (secrets are never returned).

Signed-in session only (personal API tokens are refused)

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/me/tokens" \
  -H "Authorization: Bearer <access token from sign-in>"

POST/me/tokens

Create a personal API token. The ink_… secret is in the response only once.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
namestringbodyyes
scopesarraybodyno
expiresAtstringbodyno

Responses: 201 Created · 400 Bad Request

curl
curl -X POST "$INKLINE_API/me/tokens" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

DELETE/me/tokens/{id}

Revoke a token.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
iduuidpathyes

Responses: 204 No Content · 404 Not Found

curl
curl -X DELETE "$INKLINE_API/me/tokens/{id}" \
  -H "Authorization: Bearer <access token from sign-in>"

Account

Email, password, sessions, data export and account deletion.

DELETE/me

Delete the account. Body {password} (required when the account has one). 400 invalid_password / reauth_required; 409 sole_owner_with_members.

Signed-in session only (personal API tokens are refused)

Responses: 204 No Content · 400 Bad Request · 409 Conflict

curl
curl -X DELETE "$INKLINE_API/me" \
  -H "Authorization: Bearer <access token from sign-in>"

POST/auth/verify-email

Use an email verification or email-change link. 400 invalid_token; 409 email_taken (change only).

No authentication

NameTypeInRequired
tokenstringbodyyes

Responses: 200 OK · 400 Bad Request · 409 Conflict

curl
curl -X POST "$INKLINE_API/auth/verify-email" \
  -H "Content-Type: application/json" \
  -d '{"token":"<token>"}'

POST/auth/password/forgot

Email a 30-minute reset link if the account exists. Always 202 {} (no account enumeration).

No authentication

NameTypeInRequired
emailstringbodyyes

Responses: 202 Accepted · 400 Bad Request

curl
curl -X POST "$INKLINE_API/auth/password/forgot" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>"}'

POST/auth/password/reset

Set a new password with a reset link; signs out every session. 400 invalid_token / weak_password / breached_password.

No authentication

NameTypeInRequired
tokenstringbodyyes
newPasswordstringbodyyes

Responses: 204 No Content · 400 Bad Request

curl
curl -X POST "$INKLINE_API/auth/password/reset" \
  -H "Content-Type: application/json" \
  -d '{"token":"<token>","newPassword":"<newPassword>"}'

POST/me/email/verification

Send a new verification link. 409 already_verified.

Signed-in session only (personal API tokens are refused)

Responses: 202 Accepted · 409 Conflict

curl
curl -X POST "$INKLINE_API/me/email/verification" \
  -H "Authorization: Bearer <access token from sign-in>"

POST/me/email

Send a confirmation link to the new address; the email changes when it is opened. 400 invalid_password / password_required.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
newEmailstringbodyyes
currentPasswordstringbodyyes

Responses: 202 Accepted · 400 Bad Request

curl
curl -X POST "$INKLINE_API/me/email" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"newEmail":"<newEmail>","currentPassword":"<currentPassword>"}'

POST/me/password

Change the password; signs out every other session. 400 invalid_password / password_required / weak_password / breached_password.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
currentPasswordstringbodyyes
newPasswordstringbodyyes
revokeApiTokensbooleanbodyno

Responses: 204 No Content · 400 Bad Request

curl
curl -X POST "$INKLINE_API/me/password" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"currentPassword":"<currentPassword>","newPassword":"<newPassword>"}'

GET/me/export

Download everything stored about you as JSON (attachment).

Signed-in session only (personal API tokens are refused)

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/me/export" \
  -H "Authorization: Bearer <access token from sign-in>"

GET/me/sessions

Active sign-in sessions; current = the session of this access token.

Signed-in session only (personal API tokens are refused)

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/me/sessions" \
  -H "Authorization: Bearer <access token from sign-in>"

DELETE/me/sessions

Sign out every other session (?includeCurrent=true: all sessions).

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
includeCurrentbooleanqueryno

Responses: 204 No Content

curl
curl -X DELETE "$INKLINE_API/me/sessions" \
  -H "Authorization: Bearer <access token from sign-in>"

DELETE/me/sessions/{id}

Sign out one session.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
iduuidpathyes

Responses: 204 No Content · 404 Not Found

curl
curl -X DELETE "$INKLINE_API/me/sessions/{id}" \
  -H "Authorization: Bearer <access token from sign-in>"

Auth

Sign-in flows used by the web app and `ink login`.

POST/auth/register

Create an account and its personal workspace; returns tokens.

No authentication

NameTypeInRequired
emailstringbodyyes
passwordstringbodyyes
displayNamestringbodyyes

Responses: 201 Created · 400 Bad Request · 409 Conflict

curl
curl -X POST "$INKLINE_API/auth/register" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>","password":"<password>","displayName":"<displayName>"}'

POST/auth/login

Sign in with email and password (5 failures lock the account for 15 minutes).

No authentication

NameTypeInRequired
emailstringbodyyes
passwordstringbodyyes

Responses: 200 OK · 400 Bad Request · 401 Unauthorized

curl
curl -X POST "$INKLINE_API/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>","password":"<password>"}'

POST/auth/refresh

Rotate a refresh token. Reusing an old token revokes the whole token family.

No authentication

NameTypeInRequired
refreshTokenstringbodyyes

Responses: 200 OK · 400 Bad Request · 401 Unauthorized

curl
curl -X POST "$INKLINE_API/auth/refresh" \
  -H "Content-Type: application/json" \
  -d '{"refreshToken":"<refreshToken>"}'

POST/auth/logout

Revoke the refresh token's family. Always 204.

No authentication

NameTypeInRequired
refreshTokenstringbodyyes

Responses: 204 No Content · 400 Bad Request

curl
curl -X POST "$INKLINE_API/auth/logout" \
  -H "Content-Type: application/json" \
  -d '{"refreshToken":"<refreshToken>"}'

POST/auth/device/code

Start a CLI device login (RFC 8628).

No authentication

Responses: 200 OK

curl
curl -X POST "$INKLINE_API/auth/device/code"

POST/auth/device/approve

Signed-in web user approves the code shown by the CLI.

Signed-in session only (personal API tokens are refused)

NameTypeInRequired
userCodestringbodyyes

Responses: 204 No Content · 400 Bad Request · 404 Not Found

curl
curl -X POST "$INKLINE_API/auth/device/approve" \
  -H "Authorization: Bearer <access token from sign-in>" \
  -H "Content-Type: application/json" \
  -d '{"userCode":"<userCode>"}'

POST/auth/device/token

CLI poll. 428 authorization_pending, 429 slow_down, 400 expired_token / invalid_grant.

No authentication

NameTypeInRequired
deviceCodestringbodyyes

Responses: 200 OK · 400 Bad Request · 428 Precondition Required · 429 Too Many Requests

curl
curl -X POST "$INKLINE_API/auth/device/token" \
  -H "Content-Type: application/json" \
  -d '{"deviceCode":"<deviceCode>"}'

GET/auth/oauth/providers

Names of the enabled OAuth providers.

No authentication

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/auth/oauth/providers"

GET/auth/oauth/{provider}/start

Redirect to the provider's consent screen. Requires redirectUri (allow-listed) and nonceHash (base64url SHA-256 of the browser nonce).

No authentication

NameTypeInRequired
providerstringpathyes
redirectUristringqueryno
nonceHashstringqueryno

Responses: 302 Found · 400 Bad Request · 404 Not Found

curl
curl -X GET "$INKLINE_API/auth/oauth/{provider}/start"

GET/auth/oauth/{provider}/callback

Provider callback; redirects to the web app with ?code= or ?error=.

No authentication

NameTypeInRequired
providerstringpathyes
codestringqueryno
statestringqueryno
errorstringqueryno

Responses: 302 Found · 400 Bad Request

curl
curl -X GET "$INKLINE_API/auth/oauth/{provider}/callback"

POST/auth/oauth/exchange

Exchange the one-time code and the browser nonce for tokens (single use, 60 s). Any failure: 401 invalid_grant and the code is spent.

No authentication

NameTypeInRequired
codestringbodyyes
noncestringbodyyes

Responses: 200 OK · 400 Bad Request · 401 Unauthorized

curl
curl -X POST "$INKLINE_API/auth/oauth/exchange" \
  -H "Content-Type: application/json" \
  -d '{"code":"<code>","nonce":"<nonce>"}'

Health

Liveness for monitors.

GET/healthz

No authentication

Responses: 200 OK

curl
curl -X GET "$INKLINE_API/healthz"