Create a scoped Agent Connection
curl --request POST \
--url https://api.paywithlocus.com/api/credits/agent-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalUserId": "<string>",
"tools": {
"enable": [
"<string>"
]
},
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"expiresInSeconds": 15768150
}
'import requests
url = "https://api.paywithlocus.com/api/credits/agent-connections"
payload = {
"name": "<string>",
"externalUserId": "<string>",
"tools": { "enable": ["<string>"] },
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"expiresInSeconds": 15768150
}
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>',
externalUserId: '<string>',
tools: {enable: ['<string>']},
pricing: {markupBps: 5000, flatMarkupUsdc: '<string>', endpoints: {}},
maxCreditsPerCall: '<string>',
maxCreditsPerLoop: '<string>',
expiresInSeconds: 15768150
})
};
fetch('https://api.paywithlocus.com/api/credits/agent-connections', 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.paywithlocus.com/api/credits/agent-connections",
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>',
'externalUserId' => '<string>',
'tools' => [
'enable' => [
'<string>'
]
],
'pricing' => [
'markupBps' => 5000,
'flatMarkupUsdc' => '<string>',
'endpoints' => [
]
],
'maxCreditsPerCall' => '<string>',
'maxCreditsPerLoop' => '<string>',
'expiresInSeconds' => 15768150
]),
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://api.paywithlocus.com/api/credits/agent-connections"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\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://api.paywithlocus.com/api/credits/agent-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/agent-connections")
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 \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"connection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"mode": "platform",
"keyPrefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"mcp": {
"url": "<string>",
"headers": {}
},
"externalUserId": "<string>",
"tools": {
"enable": [
"<string>"
]
},
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"revokedAt": "2023-11-07T05:31:56Z",
"rotatedAt": "2023-11-07T05:31:56Z",
"lastUsedAt": "2023-11-07T05:31:56Z",
"credential": "<string>"
}
}{
"success": false,
"error": "Forbidden",
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"requiredScopes": [
"tenant:read"
],
"presentScopes": [
"tenant:read"
]
}Authentication
Create a scoped Agent Connection
Creates a short-lived, least-privilege lcac_ credential for MCP and wrapped execution. A secret key may automate this route only when its stored scopes include credentials:manage. Human callers must be the workspace owner with fresh MFA/passkey step-up.
POST
/
credits
/
agent-connections
Create a scoped Agent Connection
curl --request POST \
--url https://api.paywithlocus.com/api/credits/agent-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"externalUserId": "<string>",
"tools": {
"enable": [
"<string>"
]
},
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"expiresInSeconds": 15768150
}
'import requests
url = "https://api.paywithlocus.com/api/credits/agent-connections"
payload = {
"name": "<string>",
"externalUserId": "<string>",
"tools": { "enable": ["<string>"] },
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"expiresInSeconds": 15768150
}
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>',
externalUserId: '<string>',
tools: {enable: ['<string>']},
pricing: {markupBps: 5000, flatMarkupUsdc: '<string>', endpoints: {}},
maxCreditsPerCall: '<string>',
maxCreditsPerLoop: '<string>',
expiresInSeconds: 15768150
})
};
fetch('https://api.paywithlocus.com/api/credits/agent-connections', 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.paywithlocus.com/api/credits/agent-connections",
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>',
'externalUserId' => '<string>',
'tools' => [
'enable' => [
'<string>'
]
],
'pricing' => [
'markupBps' => 5000,
'flatMarkupUsdc' => '<string>',
'endpoints' => [
]
],
'maxCreditsPerCall' => '<string>',
'maxCreditsPerLoop' => '<string>',
'expiresInSeconds' => 15768150
]),
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://api.paywithlocus.com/api/credits/agent-connections"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\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://api.paywithlocus.com/api/credits/agent-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/agent-connections")
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 \"externalUserId\": \"<string>\",\n \"tools\": {\n \"enable\": [\n \"<string>\"\n ]\n },\n \"pricing\": {\n \"markupBps\": 5000,\n \"flatMarkupUsdc\": \"<string>\",\n \"endpoints\": {}\n },\n \"maxCreditsPerCall\": \"<string>\",\n \"maxCreditsPerLoop\": \"<string>\",\n \"expiresInSeconds\": 15768150\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"connection": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"mode": "platform",
"keyPrefix": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"mcp": {
"url": "<string>",
"headers": {}
},
"externalUserId": "<string>",
"tools": {
"enable": [
"<string>"
]
},
"pricing": {
"markupBps": 5000,
"flatMarkupUsdc": "<string>",
"endpoints": {}
},
"maxCreditsPerCall": "<string>",
"maxCreditsPerLoop": "<string>",
"revokedAt": "2023-11-07T05:31:56Z",
"rotatedAt": "2023-11-07T05:31:56Z",
"lastUsedAt": "2023-11-07T05:31:56Z",
"credential": "<string>"
}
}{
"success": false,
"error": "Forbidden",
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"requiredScopes": [
"tenant:read"
],
"presentScopes": [
"tenant:read"
]
}Authorizations
dashboardSessionsecretKey
Locus Pro dashboard session (Cognito).
Body
application/json
Required string length:
1 - 100Available options:
platform, end_user Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
Required string length:
1 - 200Pattern:
^[A-Za-z0-9][A-Za-z0-9._:@/-]{0,199}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
Pattern:
^\d+(?:\.\d{1,6})?$Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
Pattern:
^\d+(?:\.\d{1,6})?$Required range:
300 <= x <= 31536000