Create a biolink

curl --request POST \
  --url https://biq.li/api/v1/bio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "external_id": "<string>",
  "description": "<string>",
  "alias": "<string>",
  "domain_id": "<string>",
  "active": true,
  "password": "<string>",
  "activates_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "allow_search_engine_indexing": true
}
'

import requests

url = "https://biq.li/api/v1/bio"

payload = {
    "name": "<string>",
    "external_id": "<string>",
    "description": "<string>",
    "alias": "<string>",
    "domain_id": "<string>",
    "active": True,
    "password": "<string>",
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "allow_search_engine_indexing": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    external_id: '<string>',
    description: '<string>',
    alias: '<string>',
    domain_id: '<string>',
    active: true,
    password: '<string>',
    activates_at: '2023-11-07T05:31:56Z',
    expires_at: '2023-11-07T05:31:56Z',
    allow_search_engine_indexing: true
  })
};

fetch('https://biq.li/api/v1/bio', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://biq.li/api/v1/bio",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'external_id' => '<string>',
    'description' => '<string>',
    'alias' => '<string>',
    'domain_id' => '<string>',
    'active' => true,
    'password' => '<string>',
    'activates_at' => '2023-11-07T05:31:56Z',
    'expires_at' => '2023-11-07T05:31:56Z',
    'allow_search_engine_indexing' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://biq.li/api/v1/bio"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://biq.li/api/v1/bio")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://biq.li/api/v1/bio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}"

response = http.request(request)
puts response.read_body

{
  "biolink": {
    "id": "<string>",
    "external_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "short_url": "<string>",
    "alias": "<string>",
    "domain_id": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "allow_search_engine_indexing": true,
    "links_count": 1,
    "clicks_count": 1,
    "clicked_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

POST

bio

Create a biolink

curl --request POST \
  --url https://biq.li/api/v1/bio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "external_id": "<string>",
  "description": "<string>",
  "alias": "<string>",
  "domain_id": "<string>",
  "active": true,
  "password": "<string>",
  "activates_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "allow_search_engine_indexing": true
}
'

import requests

url = "https://biq.li/api/v1/bio"

payload = {
    "name": "<string>",
    "external_id": "<string>",
    "description": "<string>",
    "alias": "<string>",
    "domain_id": "<string>",
    "active": True,
    "password": "<string>",
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "allow_search_engine_indexing": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    external_id: '<string>',
    description: '<string>',
    alias: '<string>',
    domain_id: '<string>',
    active: true,
    password: '<string>',
    activates_at: '2023-11-07T05:31:56Z',
    expires_at: '2023-11-07T05:31:56Z',
    allow_search_engine_indexing: true
  })
};

fetch('https://biq.li/api/v1/bio', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://biq.li/api/v1/bio",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'external_id' => '<string>',
    'description' => '<string>',
    'alias' => '<string>',
    'domain_id' => '<string>',
    'active' => true,
    'password' => '<string>',
    'activates_at' => '2023-11-07T05:31:56Z',
    'expires_at' => '2023-11-07T05:31:56Z',
    'allow_search_engine_indexing' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://biq.li/api/v1/bio"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://biq.li/api/v1/bio")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://biq.li/api/v1/bio")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"description\": \"<string>\",\n  \"alias\": \"<string>\",\n  \"domain_id\": \"<string>\",\n  \"active\": true,\n  \"password\": \"<string>\",\n  \"activates_at\": \"2023-11-07T05:31:56Z\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"allow_search_engine_indexing\": true\n}"

response = http.request(request)
puts response.read_body

{
  "biolink": {
    "id": "<string>",
    "external_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "short_url": "<string>",
    "alias": "<string>",
    "domain_id": "<string>",
    "active": true,
    "has_password": true,
    "activates_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "allow_search_engine_indexing": true,
    "links_count": 1,
    "clicks_count": 1,
    "clicked_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": "success"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "invalid_token",
    "message": "<string>",
    "details": {}
  },
  "request_id": "<string>"
}

Create a bio page in the workspace bound to your API key. The endpoint creates the page itself. Design, widgets, and page content remain managed in the Biqli dashboard.

Do not send a workspace ID. Every biqli_ API key belongs to one workspace, and the new biolink is always created there.

Authentication and permission

Send the API key as a Bearer token. The key needs Biolinks: Write with the biolinks.create permission. A request containing domain_id also needs Custom domains: Read (custom_domains.view).

Authorization: Bearer biqli_your_workspace_api_key
Accept: application/json
Content-Type: application/json

Minimal request

Only name is required. Biqli generates an available alias on the default domain when you omit alias and domain_id.

curl --request POST \
  --url https://biq.li/api/v1/bio \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Acme profile"
  }'

Request fields

Field	Type	Required	Behavior
`name`	string	Yes	Internal page name. Between 3 and 250 characters.
`external_id`	string or null	No	Your integration’s identifier. Maximum 255 characters and unique in the workspace.
`description`	string or null	No	Page description and basic search metadata. Maximum 250 characters.
`alias`	string	No	Custom path for the short URL. The workspace alias length and character rules apply.
`domain_id`	string or null	No	Public `biq_dom_...` ID of a domain available in this workspace. Omit or use `null` for the default Biqli domain.
`active`	boolean	No	Whether visitors can open the page. Defaults to `true`.
`password`	string or null	No	Visitor password. Maximum 250 characters. It is never returned by the API.
`activates_at`	ISO 8601 date-time or null	No	Time at which the page becomes available.
`expires_at`	ISO 8601 date-time or null	No	Time at which the page expires.
`allow_search_engine_indexing`	boolean	No	Whether search engines may index the page. Defaults to `false`.

Use public resource IDs only. Numeric database IDs are not accepted. The selected domain must belong to, or be attached to, the API key’s workspace. When both schedules are set, expires_at must be later than activates_at.

Complete example

curl --request POST \
  --url https://biq.li/api/v1/bio \
  --header 'Authorization: Bearer biqli_your_workspace_api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Acme profile",
    "external_id": "creator-page-1842",
    "description": "Official links for Acme.",
    "alias": "acme",
    "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
    "active": true,
    "password": "preview-2026",
    "activates_at": "2026-09-01T08:00:00Z",
    "expires_at": "2027-01-01T00:00:00Z",
    "allow_search_engine_indexing": false
  }'

Successful response

Success returns 201 Created and the complete public API representation of the page.

{
  "biolink": {
    "id": "biq_bio_01M19R8Q6G4S2PT7VNZ5K0W3CX",
    "external_id": "creator-page-1842",
    "name": "Acme profile",
    "description": "Official links for Acme.",
    "short_url": "https://go.example.com/acme",
    "alias": "acme",
    "domain_id": "biq_dom_01M14C6KQ6SG2GKMCV7HQ9A1QT",
    "active": true,
    "has_password": true,
    "activates_at": "2026-09-01T08:00:00+00:00",
    "expires_at": "2027-01-01T00:00:00+00:00",
    "allow_search_engine_indexing": false,
    "links_count": 0,
    "clicks_count": 0,
    "clicked_at": null,
    "created_at": "2026-08-30T11:42:19+00:00",
    "updated_at": "2026-08-30T11:42:19+00:00"
  },
  "status": "success"
}

has_password tells you whether protection is enabled. Biqli never returns the plaintext password or its hash. It also does not return widgets, page content, appearance settings, internal workspace IDs, or internal database IDs.

Conflicts and validation

Names are unique across the workspace’s folder and biolink resources.
Aliases are unique per domain across links, folders, and biolinks.
external_id can be used to prevent duplicate integration records.
Unknown fields are rejected. This includes workspaceId, workspace_id, content, widgets, and appearance.

HTTP status	Error code	Meaning
`401`	`invalid_token`	The API key is missing, invalid, or revoked.
`403`	`insufficient_scope`	The key lacks `biolinks.create`, lacks `custom_domains.view` when selecting a domain, or its user cannot create pages in the workspace.
`404`	`resource_not_found`	The supplied domain is not available in the key’s workspace.
`409`	`alias_taken`	The alias is already used on the selected domain.
`409`	`external_id_taken`	The external ID is already used in the workspace.
`409`	`biolink_name_taken`	A biolink already uses the name.
`409`	`folder_name_taken`	A folder already uses the name.
`422`	`validation_error`	A field is missing, invalid, or unsupported.
`429`	`rate_limit_exceeded`	The workspace exceeded its API request limit.

This endpoint does not accept an idempotency key. For retry-safe creation, provide a unique external_id or a caller-controlled alias and handle a possible 409 response.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization

string

header

required

A workspace API key beginning with biqli_.

Body

application/json

name

string

required

Required string length: 3 - 250

external_id

string | null

Required string length: 1 - 255

description

string | null

Maximum string length: 250

alias

string

domain_id

string | null

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$

active

boolean

password

string | null

write-only

Maximum string length: 250

activates_at

string<date-time> | null

expires_at

string<date-time> | null

allow_search_engine_indexing

boolean

Response

Biolink created.

biolink

object

required

Stable page-level settings and aggregate counts. Frontend-owned content, widgets, layout, and appearance are omitted.

Show child attributes

status

string

required

Allowed value: "success"

GETTING STARTED

BIQLI LINKS API

Create a biolink

Authentication and permission

Minimal request

Request fields

Complete example

Successful response

Conflicts and validation

Shared API behavior

Authorizations

Body

Response

​Authentication and permission

​Minimal request

​Request fields

​Complete example

​Successful response

​Conflicts and validation

​Shared API behavior

Authorizations

Body

Response

Authentication and permission

Minimal request

Request fields

Complete example

Successful response

Conflicts and validation

Shared API behavior