curl --request PUT \
--url https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"apiKey": "<string>",
"organizationId": "<string>",
"connectionId": "<string>",
"forProjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passkey": "<string>",
"removePasskey": true,
"version": 123,
"aiChat": true
}
'import requests
url = "https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link"
payload = {
"apiKey": "<string>",
"organizationId": "<string>",
"connectionId": "<string>",
"forProjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passkey": "<string>",
"removePasskey": True,
"version": 123,
"aiChat": True
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apiKey: '<string>',
organizationId: '<string>',
connectionId: '<string>',
forProjectUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
passkey: '<string>',
removePasskey: true,
version: 123,
aiChat: true
})
};
fetch('https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link', 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://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'apiKey' => '<string>',
'organizationId' => '<string>',
'connectionId' => '<string>',
'forProjectUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'passkey' => '<string>',
'removePasskey' => true,
'version' => 123,
'aiChat' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link"
payload := strings.NewReader("{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("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.put("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"link": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"mode": "live",
"hasPasskey": true,
"version": 123,
"aiChat": true,
"expiresAt": "<unknown>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
},
"customShareDomain": "<string>",
"liveAllowed": true
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Create Canvas Link
Make your own passkey-protected link to a canvas you own, or change its passkey or the saved version it shows. Visitors see the canvas as you see it, live.
curl --request PUT \
--url https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"apiKey": "<string>",
"organizationId": "<string>",
"connectionId": "<string>",
"forProjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passkey": "<string>",
"removePasskey": true,
"version": 123,
"aiChat": true
}
'import requests
url = "https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link"
payload = {
"apiKey": "<string>",
"organizationId": "<string>",
"connectionId": "<string>",
"forProjectUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"passkey": "<string>",
"removePasskey": True,
"version": 123,
"aiChat": True
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
apiKey: '<string>',
organizationId: '<string>',
connectionId: '<string>',
forProjectUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
passkey: '<string>',
removePasskey: true,
version: 123,
aiChat: true
})
};
fetch('https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link', 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://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'apiKey' => '<string>',
'organizationId' => '<string>',
'connectionId' => '<string>',
'forProjectUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'passkey' => '<string>',
'removePasskey' => true,
'version' => 123,
'aiChat' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link"
payload := strings.NewReader("{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("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.put("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upsolve.ai/v2/api/projects/{projectId}/workspaces/{workspaceId}/canvases/{canvasId}/link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"connectionId\": \"<string>\",\n \"forProjectUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"passkey\": \"<string>\",\n \"removePasskey\": true,\n \"version\": 123,\n \"aiChat\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"link": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"mode": "live",
"hasPasskey": true,
"version": 123,
"aiChat": true,
"expiresAt": "<unknown>",
"createdAt": "<unknown>",
"updatedAt": "<unknown>"
},
"customShareDomain": "<string>",
"liveAllowed": true
}
}{
"status": "error",
"error": {
"message": "<string>",
"code": "<string>",
"details": {}
}
}Authorizations
Path Parameters
The project in the URL. The caller's project user is read from it.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/link Parameter
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/link Parameter
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$Body
PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/link Request body
Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.
1The ID of the organization. Required when using Supabase JWT authentication.
The ID of the connection a guest has access to
With an organization credential: the owner of the canvas whose link this is (the Playground's previewed user). Omitted, it is the builders' link on a canvas no project user owns, which can only show saved rows. A project-user token always acts on its own link.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$What a visitor sees: snapshot (the charts' saved rows), live (every chart run as you) or both. Defaults to snapshot when making a link. Live and both need a passkey.
live, snapshot, both The passkey a visitor must type, 6 to 72 bytes. Required for a live or both link; optional on a snapshot one. On an existing link, sets a new one. Never returned.
6Remove the passkey, so anyone with the address can open the link. A snapshot link's alone.
The saved version of the canvas the link shows. Defaults to the latest saved version when making a link; a canvas with none must save one first.
x <= 9007199254740991Whether the link offers its visitors a read-only AI chat about the canvas, run as the link's owner. Only on a live or both link, which has an owner and a passkey. Off when making a link unless set; absent leaves it as it is.
Was this page helpful?