Skip to main content
POST
/
api
/
v1
/
links
create link
curl --request POST \
  --url https://{defaultHost}/api/v1/links \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '
{
  "target_url": "<string>",
  "title": "<string>",
  "description": "<string>",
  "latitude": 123,
  "longitude": 123,
  "image_url": "<string>",
  "image_data": "<string>",
  "tags": [
    "<string>"
  ],
  "collection_ids": [
    123
  ],
  "repository_ids": [
    123
  ],
  "page_content": "<string>"
}
'
import requests

url = "https://{defaultHost}/api/v1/links"

payload = {
"target_url": "<string>",
"title": "<string>",
"description": "<string>",
"latitude": 123,
"longitude": 123,
"image_url": "<string>",
"image_data": "<string>",
"tags": ["<string>"],
"collection_ids": [123],
"repository_ids": [123],
"page_content": "<string>"
}
headers = {
"X-Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Authorization': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target_url: '<string>',
title: '<string>',
description: '<string>',
latitude: 123,
longitude: 123,
image_url: '<string>',
image_data: '<string>',
tags: ['<string>'],
collection_ids: [123],
repository_ids: [123],
page_content: '<string>'
})
};

fetch('https://{defaultHost}/api/v1/links', 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://{defaultHost}/api/v1/links",
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([
'target_url' => '<string>',
'title' => '<string>',
'description' => '<string>',
'latitude' => 123,
'longitude' => 123,
'image_url' => '<string>',
'image_data' => '<string>',
'tags' => [
'<string>'
],
'collection_ids' => [
123
],
'repository_ids' => [
123
],
'page_content' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Authorization: <api-key>"
],
]);

$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://{defaultHost}/api/v1/links"

payload := strings.NewReader("{\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"image_url\": \"<string>\",\n \"image_data\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collection_ids\": [\n 123\n ],\n \"repository_ids\": [\n 123\n ],\n \"page_content\": \"<string>\"\n}")

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

req.Header.Add("X-Authorization", "<api-key>")
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://{defaultHost}/api/v1/links")
.header("X-Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"image_url\": \"<string>\",\n \"image_data\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collection_ids\": [\n 123\n ],\n \"repository_ids\": [\n 123\n ],\n \"page_content\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/api/v1/links")

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

request = Net::HTTP::Post.new(url)
request["X-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"image_url\": \"<string>\",\n \"image_data\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collection_ids\": [\n 123\n ],\n \"repository_ids\": [\n 123\n ],\n \"page_content\": \"<string>\"\n}"

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

Authorizations

X-Authorization
string
header
required

Body

application/json
target_url
string
required
title
string
description
string
latitude
number
longitude
number
image_url
string
image_data
string
tags
string[]
collection_ids
integer[]
repository_ids
integer[]
page_content
string

Response

created