Create a custom API provider
curl --request POST \
--url https://api.paywithlocus.com/api/credits/custom-endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"baseUrl": "<string>",
"auth": {
"name": "<string>",
"prefix": "<string>",
"credential": "<string>"
},
"description": "<string>",
"endpoints": [
{
"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"
payload = {
"slug": "<string>",
"name": "<string>",
"baseUrl": "<string>",
"auth": {
"name": "<string>",
"prefix": "<string>",
"credential": "<string>"
},
"description": "<string>",
"endpoints": [
{
"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>',
baseUrl: '<string>',
auth: {name: '<string>', prefix: '<string>', credential: '<string>'},
description: '<string>',
endpoints: [
{
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', 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",
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>',
'baseUrl' => '<string>',
'auth' => [
'name' => '<string>',
'prefix' => '<string>',
'credential' => '<string>'
],
'description' => '<string>',
'endpoints' => [
[
'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"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\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://api.paywithlocus.com/api/credits/custom-endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/custom-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 \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"publicProvider": "<string>",
"name": "<string>",
"description": "<string>",
"baseUrl": "<string>",
"auth": {
"type": "bearer",
"name": "<string>",
"prefix": "<string>",
"configured": true,
"hint": "<string>",
"version": 1,
"updatedAt": "2023-11-07T05:31:56Z"
},
"traffic": {
"requestsPerMinute": 30000,
"maxConcurrency": 500,
"timeoutSeconds": 60,
"circuitBreaker": {
"failureThreshold": 51,
"windowSeconds": 300,
"cooldownSeconds": 1800
}
},
"endpoints": [
{
"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"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Custom APIs
Create a custom API provider
Creates one BYOK provider and optionally up to 50 actions atomically. Requires an enterprise workspace with Custom APIs enabled, the workspace owner, credentials:manage and catalog:write, plus MFA or passkey step-up completed in the last ten minutes. Locus validates the upstream URL against SSRF controls, encrypts the credential, validates every JSON Schema and example, and never returns the raw credential.
POST
/
credits
/
custom-endpoints
Create a custom API provider
curl --request POST \
--url https://api.paywithlocus.com/api/credits/custom-endpoints \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"slug": "<string>",
"name": "<string>",
"baseUrl": "<string>",
"auth": {
"name": "<string>",
"prefix": "<string>",
"credential": "<string>"
},
"description": "<string>",
"endpoints": [
{
"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"
payload = {
"slug": "<string>",
"name": "<string>",
"baseUrl": "<string>",
"auth": {
"name": "<string>",
"prefix": "<string>",
"credential": "<string>"
},
"description": "<string>",
"endpoints": [
{
"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>',
baseUrl: '<string>',
auth: {name: '<string>', prefix: '<string>', credential: '<string>'},
description: '<string>',
endpoints: [
{
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', 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",
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>',
'baseUrl' => '<string>',
'auth' => [
'name' => '<string>',
'prefix' => '<string>',
'credential' => '<string>'
],
'description' => '<string>',
'endpoints' => [
[
'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"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\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://api.paywithlocus.com/api/credits/custom-endpoints")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"name\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paywithlocus.com/api/credits/custom-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 \"baseUrl\": \"<string>\",\n \"auth\": {\n \"name\": \"<string>\",\n \"prefix\": \"<string>\",\n \"credential\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"endpoints\": [\n {\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 }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"publicProvider": "<string>",
"name": "<string>",
"description": "<string>",
"baseUrl": "<string>",
"auth": {
"type": "bearer",
"name": "<string>",
"prefix": "<string>",
"configured": true,
"hint": "<string>",
"version": 1,
"updatedAt": "2023-11-07T05:31:56Z"
},
"traffic": {
"requestsPerMinute": 30000,
"maxConcurrency": 500,
"timeoutSeconds": 60,
"circuitBreaker": {
"failureThreshold": 51,
"windowSeconds": 300,
"cooldownSeconds": 1800
}
},
"endpoints": [
{
"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"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Locus Pro dashboard session (Cognito).
Body
application/json
Stable provider name. The public catalog name is custom-{slug}.
Pattern:
^[a-z0-9][a-z0-9-]{1,62}[a-z0-9]$Required string length:
1 - 80HTTPS upstream origin validated against SSRF and private-network controls.
Maximum string length:
2048For type=none, omit credential. For type=header or type=query, supply name.
Show child attributes
Show child attributes
Maximum string length:
500Show child attributes
Show child attributes
Show child attributes
Show child attributes
Use endpoint or endpoints, never both. Slugs must be unique within the request.
Required array length:
1 - 50 elementsShow child attributes
Show child attributes