Add Link

Append a new link tile to an okl.ink page bento grid.

POST /api/v1/pages/{id}/links

cURL

curl -X POST https://okl.ink/api/v1/pages/cly1019283749/links \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com/hebuildapps/demo-links",
    "type": "github",
    "title": "okl.ink Source Code",
    "size": "2x1"
  }'

201 Created

{
  "id": "cmsh_link_99",
  "type": "github",
  "url": "https://github.com/hebuildapps/demo-links",
  "position": 0,
  "title": "okl.ink Source Code",
  "size": "2x1",
  "thumbnail": null,
  "active": true,
  "highlighted": false
}

Add Link

Adds a new link tile to the specified project. The tile is automatically assigned the next available position at the bottom of the grid. Requires pages:write scope.

Headers

Authorization · string · required

Bearer token with pages:write scope.

Path Parameters

id · string · required

The project ID.

Request Body

url · string · required

The destination http(s) URL.

type · string · default: "other"

One of: live-demo, github, documentation, youtube, x, linkedin, product-hunt, devpost, blog, other.

title · string

Custom display title for the tile.

size · string · default: "2x1"

Tile size: 1x1, 2x1, 2x2, 4x1. (Social links like x, twitter, linkedin automatically default to 2x2).

thumbnail · string

Optional custom thumbnail image URL.

Response

id · string

Created Link ID

type · string

Link type

url · string

Destination URL

position · number

Zero-indexed grid index

title · string | null

Tile Title

size · string

Tile grid span

thumbnail · string | null

Thumbnail URL

active · boolean

Active state

highlighted · boolean

Highlight state

cURL

curl -X POST https://okl.ink/api/v1/pages/cly1019283749/links \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com/hebuildapps/demo-links",
    "type": "github",
    "title": "okl.ink Source Code",
    "size": "2x1"
  }'

201 Created

{
  "id": "cmsh_link_99",
  "type": "github",
  "url": "https://github.com/hebuildapps/demo-links",
  "position": 0,
  "title": "okl.ink Source Code",
  "size": "2x1",
  "thumbnail": null,
  "active": true,
  "highlighted": false
}