Managed Sync
ActionKit
WorkflowsCreate Setup Link
curl --request POST \
--url https://zeus.useparagon.com/projects/{projectId}/setup-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endUserId": "[email protected]",
"expiresIn": 3600,
"integrations": [
"googledrive",
"sharepoint"
]
}
'import requests
url = "https://zeus.useparagon.com/projects/{projectId}/setup-links"
payload = {
"endUserId": "[email protected]",
"expiresIn": 3600,
"integrations": ["googledrive", "sharepoint"]
}
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({
endUserId: '[email protected]',
expiresIn: 3600,
integrations: ['googledrive', 'sharepoint']
})
};
fetch('https://zeus.useparagon.com/projects/{projectId}/setup-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://zeus.useparagon.com/projects/{projectId}/setup-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([
'endUserId' => '[email protected]',
'expiresIn' => 3600,
'integrations' => [
'googledrive',
'sharepoint'
]
]),
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://zeus.useparagon.com/projects/{projectId}/setup-links"
payload := strings.NewReader("{\n \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\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://zeus.useparagon.com/projects/{projectId}/setup-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeus.useparagon.com/projects/{projectId}/setup-links")
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 \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"url": "https://<connect-host>/project/6f1c0b2e-1a2b-4c3d-8e9f-0a1b2c3d4e5f/setup?token=eyJhbGciOi...",
"expiresAt": "2026-10-14T22:51:00.000Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Context
Create Setup Link
Create a hosted link where a user connects the sources Agent OS can search.
POST
/
projects
/
{projectId}
/
setup-links
Create Setup Link
curl --request POST \
--url https://zeus.useparagon.com/projects/{projectId}/setup-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endUserId": "[email protected]",
"expiresIn": 3600,
"integrations": [
"googledrive",
"sharepoint"
]
}
'import requests
url = "https://zeus.useparagon.com/projects/{projectId}/setup-links"
payload = {
"endUserId": "[email protected]",
"expiresIn": 3600,
"integrations": ["googledrive", "sharepoint"]
}
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({
endUserId: '[email protected]',
expiresIn: 3600,
integrations: ['googledrive', 'sharepoint']
})
};
fetch('https://zeus.useparagon.com/projects/{projectId}/setup-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://zeus.useparagon.com/projects/{projectId}/setup-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([
'endUserId' => '[email protected]',
'expiresIn' => 3600,
'integrations' => [
'googledrive',
'sharepoint'
]
]),
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://zeus.useparagon.com/projects/{projectId}/setup-links"
payload := strings.NewReader("{\n \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\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://zeus.useparagon.com/projects/{projectId}/setup-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://zeus.useparagon.com/projects/{projectId}/setup-links")
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 \"endUserId\": \"[email protected]\",\n \"expiresIn\": 3600,\n \"integrations\": [\n \"googledrive\",\n \"sharepoint\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"url": "https://<connect-host>/project/6f1c0b2e-1a2b-4c3d-8e9f-0a1b2c3d4e5f/setup?token=eyJhbGciOi...",
"expiresAt": "2026-10-14T22:51:00.000Z"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Call this endpoint from your backend to create a Setup Link for a Connected User. Send the returned
Setup Links must be enabled for your project. If they aren’t, the request returns a
url to your user. They open it, connect their accounts, and choose what content to sync.
This endpoint is served from https://zeus.useparagon.com (US Cloud) or https://zeus.eu.paragon.so (EU Cloud), not the Agent OS base URL used by Search Context. Use the server dropdown in the API playground to switch regions.
Authentication
Authenticate with either of the following in theAuthorization header:
| Credential | endUserId |
|---|---|
A Paragon API key with the Setup Links API scope (api_key_...) | Required. The link is created for that Connected User. |
| A Paragon User Token | Optional. It must match the token’s sub claim, and defaults to it. |
403 with the error code 56016.
Expiration
Links expire after 1 hour by default. SetexpiresIn (in seconds) to change this, up to a maximum of 24 hours.
The url contains a signed token. Treat it like a credential and share it only with the intended user.
Limiting integrations
By default, a Setup Link offers every integration enabled for the project. Passintegrations to limit it to specific ones, using the same type names as the Connect SDK. If any name isn’t enabled for the project, the request returns a 400 with the error code 56004.
When you authenticate with a Paragon User Token that restricts integration permissions, the link only offers integrations the token allows.
const response = await fetch(
`https://zeus.useparagon.com/projects/${projectId}/setup-links`,
{
method: "POST",
headers: {
Authorization: `Bearer ${paragonApiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
endUserId: "[email protected]",
expiresIn: 3600,
integrations: ["googledrive", "sharepoint"],
}),
},
);
const { url, expiresAt } = await response.json();
Authorizations
apiKeyAuthbearerAuth
A Paragon API key (starting with api_key_) that has the Setup Links API scope. Create one in the Paragon dashboard.
Path Parameters
Your Paragon Project ID.
Body
application/json
The Connected User the Setup Link is for. Required when you authenticate with an API key. When you authenticate with a Paragon User Token, it must match the token's sub claim, and defaults to it when omitted.
How long the link stays valid, in seconds. Values above 86400 (24 hours) are capped at 86400.
Required range:
1 <= x <= 86400Limit the link to these integrations, using the same type names as the Connect SDK (for example, googledrive). Every integration must be enabled for the project. Omit to allow all enabled integrations.