Create ServiceBridgeMetadata
curl --request POST \
--url https://platform.kodexa.ai/api/service-bridges \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"metadata": {
"agentCallable": true,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": true,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": true,
"cacheTtlSeconds": 123,
"cacheableVerbs": [
"<string>"
],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/service-bridges"
payload = {
"slug": "<string>",
"deprecated": True,
"extensionPackRef": "<string>",
"metadata": {
"agentCallable": True,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": True,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": True,
"cacheTtlSeconds": 123,
"cacheableVerbs": ["<string>"],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"template": True,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
deprecated: true,
extensionPackRef: '<string>',
metadata: {
agentCallable: true,
auth: {
clientId: '<string>',
clientSecret: '<string>',
tokenUrl: '<string>',
type: '<string>',
headerName: '<string>',
headerPrefix: '<string>',
requestBody: {},
requestFormat: '<string>',
responseMapping: {accessToken: '<string>', expiresIn: '<string>'},
tokenCacheBufferSeconds: 123
},
baseUrl: '<string>',
checksum: '<string>',
defaultHeaders: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
deleteProtection: true,
description: '<string>',
endpoints: [
{
method: '<string>',
name: '<string>',
path: '<string>',
cacheEnabled: true,
cacheTtlSeconds: 123,
cacheableVerbs: ['<string>'],
description: '<string>',
headers: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
initScope: '<string>',
initScript: '<string>',
postReplyScript: '<string>',
preSendScript: '<string>',
requestSchema: {},
responseSchema: {}
}
],
icon: '<string>',
imageUrl: '<string>',
overviewMarkdown: '<string>',
provider: '<string>',
providerImageUrl: '<string>',
providerUrl: '<string>'
},
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/service-bridges', 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://platform.kodexa.ai/api/service-bridges",
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>',
'deprecated' => true,
'extensionPackRef' => '<string>',
'metadata' => [
'agentCallable' => true,
'auth' => [
'clientId' => '<string>',
'clientSecret' => '<string>',
'tokenUrl' => '<string>',
'type' => '<string>',
'headerName' => '<string>',
'headerPrefix' => '<string>',
'requestBody' => [
],
'requestFormat' => '<string>',
'responseMapping' => [
'accessToken' => '<string>',
'expiresIn' => '<string>'
],
'tokenCacheBufferSeconds' => 123
],
'baseUrl' => '<string>',
'checksum' => '<string>',
'defaultHeaders' => [
[
'name' => '<string>',
'secretRef' => '<string>',
'value' => '<string>'
]
],
'deleteProtection' => true,
'description' => '<string>',
'endpoints' => [
[
'method' => '<string>',
'name' => '<string>',
'path' => '<string>',
'cacheEnabled' => true,
'cacheTtlSeconds' => 123,
'cacheableVerbs' => [
'<string>'
],
'description' => '<string>',
'headers' => [
[
'name' => '<string>',
'secretRef' => '<string>',
'value' => '<string>'
]
],
'initScope' => '<string>',
'initScript' => '<string>',
'postReplyScript' => '<string>',
'preSendScript' => '<string>',
'requestSchema' => [
],
'responseSchema' => [
]
]
],
'icon' => '<string>',
'imageUrl' => '<string>',
'overviewMarkdown' => '<string>',
'provider' => '<string>',
'providerImageUrl' => '<string>',
'providerUrl' => '<string>'
],
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<string>',
'template' => true,
'type' => '<string>',
'uri' => '<string>',
'yamlSource' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://platform.kodexa.ai/api/service-bridges"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.post("https://platform.kodexa.ai/api/service-bridges")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/service-bridges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"deprecated": true,
"id": "<string>",
"metadata": {
"agentCallable": true,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": true,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": true,
"cacheTtlSeconds": 123,
"cacheableVerbs": [
"<string>"
],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deletedDate": "2023-11-07T05:31:56Z",
"extensionPackRef": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"ref": "<string>",
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}Service Bridges
Create ServiceBridgeMetadata
Creates a new ServiceBridgeMetadata. Service bridges define external API endpoints that kodexa-api proxies on behalf of users.
POST
/
api
/
service-bridges
Create ServiceBridgeMetadata
curl --request POST \
--url https://platform.kodexa.ai/api/service-bridges \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"slug": "<string>",
"deprecated": true,
"extensionPackRef": "<string>",
"metadata": {
"agentCallable": true,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": true,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": true,
"cacheTtlSeconds": 123,
"cacheableVerbs": [
"<string>"
],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"ref": "<string>",
"template": true,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/service-bridges"
payload = {
"slug": "<string>",
"deprecated": True,
"extensionPackRef": "<string>",
"metadata": {
"agentCallable": True,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": True,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": True,
"cacheTtlSeconds": 123,
"cacheableVerbs": ["<string>"],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"orgSlug": "<string>",
"organization": { "id": "<string>" },
"organizationId": "<string>",
"publicAccess": True,
"ref": "<string>",
"template": True,
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: '<string>',
deprecated: true,
extensionPackRef: '<string>',
metadata: {
agentCallable: true,
auth: {
clientId: '<string>',
clientSecret: '<string>',
tokenUrl: '<string>',
type: '<string>',
headerName: '<string>',
headerPrefix: '<string>',
requestBody: {},
requestFormat: '<string>',
responseMapping: {accessToken: '<string>', expiresIn: '<string>'},
tokenCacheBufferSeconds: 123
},
baseUrl: '<string>',
checksum: '<string>',
defaultHeaders: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
deleteProtection: true,
description: '<string>',
endpoints: [
{
method: '<string>',
name: '<string>',
path: '<string>',
cacheEnabled: true,
cacheTtlSeconds: 123,
cacheableVerbs: ['<string>'],
description: '<string>',
headers: [{name: '<string>', secretRef: '<string>', value: '<string>'}],
initScope: '<string>',
initScript: '<string>',
postReplyScript: '<string>',
preSendScript: '<string>',
requestSchema: {},
responseSchema: {}
}
],
icon: '<string>',
imageUrl: '<string>',
overviewMarkdown: '<string>',
provider: '<string>',
providerImageUrl: '<string>',
providerUrl: '<string>'
},
name: '<string>',
orgSlug: '<string>',
organization: {id: '<string>'},
organizationId: '<string>',
publicAccess: true,
ref: '<string>',
template: true,
type: '<string>',
uri: '<string>',
yamlSource: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/service-bridges', 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://platform.kodexa.ai/api/service-bridges",
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>',
'deprecated' => true,
'extensionPackRef' => '<string>',
'metadata' => [
'agentCallable' => true,
'auth' => [
'clientId' => '<string>',
'clientSecret' => '<string>',
'tokenUrl' => '<string>',
'type' => '<string>',
'headerName' => '<string>',
'headerPrefix' => '<string>',
'requestBody' => [
],
'requestFormat' => '<string>',
'responseMapping' => [
'accessToken' => '<string>',
'expiresIn' => '<string>'
],
'tokenCacheBufferSeconds' => 123
],
'baseUrl' => '<string>',
'checksum' => '<string>',
'defaultHeaders' => [
[
'name' => '<string>',
'secretRef' => '<string>',
'value' => '<string>'
]
],
'deleteProtection' => true,
'description' => '<string>',
'endpoints' => [
[
'method' => '<string>',
'name' => '<string>',
'path' => '<string>',
'cacheEnabled' => true,
'cacheTtlSeconds' => 123,
'cacheableVerbs' => [
'<string>'
],
'description' => '<string>',
'headers' => [
[
'name' => '<string>',
'secretRef' => '<string>',
'value' => '<string>'
]
],
'initScope' => '<string>',
'initScript' => '<string>',
'postReplyScript' => '<string>',
'preSendScript' => '<string>',
'requestSchema' => [
],
'responseSchema' => [
]
]
],
'icon' => '<string>',
'imageUrl' => '<string>',
'overviewMarkdown' => '<string>',
'provider' => '<string>',
'providerImageUrl' => '<string>',
'providerUrl' => '<string>'
],
'name' => '<string>',
'orgSlug' => '<string>',
'organization' => [
'id' => '<string>'
],
'organizationId' => '<string>',
'publicAccess' => true,
'ref' => '<string>',
'template' => true,
'type' => '<string>',
'uri' => '<string>',
'yamlSource' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://platform.kodexa.ai/api/service-bridges"
payload := strings.NewReader("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.post("https://platform.kodexa.ai/api/service-bridges")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/service-bridges")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"<string>\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"metadata\": {\n \"agentCallable\": true,\n \"auth\": {\n \"clientId\": \"<string>\",\n \"clientSecret\": \"<string>\",\n \"tokenUrl\": \"<string>\",\n \"type\": \"<string>\",\n \"headerName\": \"<string>\",\n \"headerPrefix\": \"<string>\",\n \"requestBody\": {},\n \"requestFormat\": \"<string>\",\n \"responseMapping\": {\n \"accessToken\": \"<string>\",\n \"expiresIn\": \"<string>\"\n },\n \"tokenCacheBufferSeconds\": 123\n },\n \"baseUrl\": \"<string>\",\n \"checksum\": \"<string>\",\n \"defaultHeaders\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"endpoints\": [\n {\n \"method\": \"<string>\",\n \"name\": \"<string>\",\n \"path\": \"<string>\",\n \"cacheEnabled\": true,\n \"cacheTtlSeconds\": 123,\n \"cacheableVerbs\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"headers\": [\n {\n \"name\": \"<string>\",\n \"secretRef\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"initScope\": \"<string>\",\n \"initScript\": \"<string>\",\n \"postReplyScript\": \"<string>\",\n \"preSendScript\": \"<string>\",\n \"requestSchema\": {},\n \"responseSchema\": {}\n }\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"orgSlug\": \"<string>\",\n \"organization\": {\n \"id\": \"<string>\"\n },\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"ref\": \"<string>\",\n \"template\": true,\n \"type\": \"<string>\",\n \"uri\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"deprecated": true,
"id": "<string>",
"metadata": {
"agentCallable": true,
"auth": {
"clientId": "<string>",
"clientSecret": "<string>",
"tokenUrl": "<string>",
"type": "<string>",
"headerName": "<string>",
"headerPrefix": "<string>",
"requestBody": {},
"requestFormat": "<string>",
"responseMapping": {
"accessToken": "<string>",
"expiresIn": "<string>"
},
"tokenCacheBufferSeconds": 123
},
"baseUrl": "<string>",
"checksum": "<string>",
"defaultHeaders": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"deleteProtection": true,
"description": "<string>",
"endpoints": [
{
"method": "<string>",
"name": "<string>",
"path": "<string>",
"cacheEnabled": true,
"cacheTtlSeconds": 123,
"cacheableVerbs": [
"<string>"
],
"description": "<string>",
"headers": [
{
"name": "<string>",
"secretRef": "<string>",
"value": "<string>"
}
],
"initScope": "<string>",
"initScript": "<string>",
"postReplyScript": "<string>",
"preSendScript": "<string>",
"requestSchema": {},
"responseSchema": {}
}
],
"icon": "<string>",
"imageUrl": "<string>",
"overviewMarkdown": "<string>",
"provider": "<string>",
"providerImageUrl": "<string>",
"providerUrl": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deletedDate": "2023-11-07T05:31:56Z",
"extensionPackRef": "<string>",
"orgSlug": "<string>",
"organization": {
"id": "<string>"
},
"ref": "<string>",
"type": "<string>",
"uri": "<string>",
"yamlSource": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.
Response
Created ServiceBridgeMetadata
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Computed resource URI (scheme://orgSlug/slug), present on serialized responses.