curl --request POST \
--url https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"providerCostUsdc": "<string>",
"markupBps": 50000,
"flatMarkupUsdc": "<string>",
"outputSchema": {},
"outputExample": "<unknown>",
"enabled": false
}
'import requests
url = "https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints"
payload = {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"providerCostUsdc": "<string>",
"markupBps": 50000,
"flatMarkupUsdc": "<string>",
"outputSchema": {},
"outputExample": "<unknown>",
"enabled": False
}
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({
slug: '<string>',
name: '<string>',
description: '<string>',
path: '<string>',
inputSchema: {},
inputExample: {},
providerCostUsdc: '<string>',
markupBps: 50000,
flatMarkupUsdc: '<string>',
outputSchema: {},
outputExample: '<unknown>',
enabled: false
})
};
fetch('https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints', 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/custom-endpoints/{providerId}/endpoints",
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([
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'path' => '<string>',
'inputSchema' => [
],
'inputExample' => [
],
'providerCostUsdc' => '<string>',
'markupBps' => 50000,
'flatMarkupUsdc' => '<string>',
'outputSchema' => [
],
'outputExample' => '<unknown>',
'enabled' => false
]),
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/custom-endpoints/{providerId}/endpoints"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\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/custom-endpoints/{providerId}/endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints")
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 \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"endpoint": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"publicSlug": "<string>",
"name": "<string>",
"description": "<string>",
"method": "GET",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"outputSchema": {},
"outputExample": "<unknown>",
"providerCostUsdc": "<string>",
"markupBps": 1,
"flatMarkupUsdc": "<string>",
"endUserPriceUsdc": "<string>",
"enabled": true,
"pricingRevision": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Create an action for a custom provider
Creates one disabled-by-default or explicitly enabled action. Its input schema must describe an object, its example must validate, path placeholders must resolve to scalar schema properties, and the top-level names externalUserId, attribution, and _locus are reserved for Locus transport controls. Publishing an enabled action requires a positive end-user price.
curl --request POST \
--url https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"providerCostUsdc": "<string>",
"markupBps": 50000,
"flatMarkupUsdc": "<string>",
"outputSchema": {},
"outputExample": "<unknown>",
"enabled": false
}
'import requests
url = "https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints"
payload = {
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"providerCostUsdc": "<string>",
"markupBps": 50000,
"flatMarkupUsdc": "<string>",
"outputSchema": {},
"outputExample": "<unknown>",
"enabled": False
}
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({
slug: '<string>',
name: '<string>',
description: '<string>',
path: '<string>',
inputSchema: {},
inputExample: {},
providerCostUsdc: '<string>',
markupBps: 50000,
flatMarkupUsdc: '<string>',
outputSchema: {},
outputExample: '<unknown>',
enabled: false
})
};
fetch('https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints', 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/custom-endpoints/{providerId}/endpoints",
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([
'slug' => '<string>',
'name' => '<string>',
'description' => '<string>',
'path' => '<string>',
'inputSchema' => [
],
'inputExample' => [
],
'providerCostUsdc' => '<string>',
'markupBps' => 50000,
'flatMarkupUsdc' => '<string>',
'outputSchema' => [
],
'outputExample' => '<unknown>',
'enabled' => false
]),
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/custom-endpoints/{providerId}/endpoints"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\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/custom-endpoints/{providerId}/endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/custom-endpoints/{providerId}/endpoints")
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 \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"path\": \"<string>\",\n \"inputSchema\": {},\n \"inputExample\": {},\n \"providerCostUsdc\": \"<string>\",\n \"markupBps\": 50000,\n \"flatMarkupUsdc\": \"<string>\",\n \"outputSchema\": {},\n \"outputExample\": \"<unknown>\",\n \"enabled\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"endpoint": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"publicSlug": "<string>",
"name": "<string>",
"description": "<string>",
"method": "GET",
"path": "<string>",
"inputSchema": {},
"inputExample": {},
"outputSchema": {},
"outputExample": "<unknown>",
"providerCostUsdc": "<string>",
"markupBps": 1,
"flatMarkupUsdc": "<string>",
"endUserPriceUsdc": "<string>",
"enabled": true,
"pricingRevision": 1,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Locus Pro dashboard session (Cognito).
Path Parameters
Workspace-owned custom provider ID. This is distinct from its public custom-{slug} catalog name.
Body
Stable 3–64 character action name.
^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$1 - 801 - 500GET, POST, PUT, PATCH, DELETE Upstream path. Placeholders must reference required scalar properties from inputSchema.
1 - 1024Compilable JSON Schema, at most 64 KiB and 32 levels deep, whose root type is object. Top-level transport-control names are reserved.
Executable example that must satisfy inputSchema.
Upstream provider cost in USD, rounded up to six decimal places.
^\d+(?:\.\d{1,6})?$Percentage markup, also limited by the workspace's effective cap.
0 <= x <= 100000Flat USD markup, also limited by the workspace's effective cap.
^\d+(?:\.\d{1,6})?$Optional JSON Schema, at most 64 KiB and 32 levels deep.
Optional example that must satisfy outputSchema when both are provided.
Enabled actions must have a positive end-user price.