Skip to main content
POST
/
v0
/
experimental
/
edges
Create a new cross-service edge.
curl --request POST \
  --url https://{hostname}.gable.ai/v0/experimental/edges \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source": {
    "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "component_name": "<string>",
    "payload_name": "<string>",
    "kind": "<string>",
    "xgress_id": "<string>"
  },
  "destination": {
    "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "component_name": "<string>",
    "payload_name": "<string>",
    "kind": "<string>",
    "xgress_id": "<string>"
  },
  "field_mappings": [
    {
      "source_field": "<string>",
      "destination_field": "<string>",
      "notes": "<string>"
    }
  ],
  "namespace": "<string>",
  "reason": "<string>"
}
'
import requests

url = "https://{hostname}.gable.ai/v0/experimental/edges"

payload = {
    "source": {
        "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "component_name": "<string>",
        "payload_name": "<string>",
        "kind": "<string>",
        "xgress_id": "<string>"
    },
    "destination": {
        "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "component_name": "<string>",
        "payload_name": "<string>",
        "kind": "<string>",
        "xgress_id": "<string>"
    },
    "field_mappings": [
        {
            "source_field": "<string>",
            "destination_field": "<string>",
            "notes": "<string>"
        }
    ],
    "namespace": "<string>",
    "reason": "<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({
    source: {
      component_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      component_name: '<string>',
      payload_name: '<string>',
      kind: '<string>',
      xgress_id: '<string>'
    },
    destination: {
      component_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      component_name: '<string>',
      payload_name: '<string>',
      kind: '<string>',
      xgress_id: '<string>'
    },
    field_mappings: [{source_field: '<string>', destination_field: '<string>', notes: '<string>'}],
    namespace: '<string>',
    reason: '<string>'
  })
};

fetch('https://{hostname}.gable.ai/v0/experimental/edges', 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://{hostname}.gable.ai/v0/experimental/edges",
  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([
    'source' => [
        'component_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'component_name' => '<string>',
        'payload_name' => '<string>',
        'kind' => '<string>',
        'xgress_id' => '<string>'
    ],
    'destination' => [
        'component_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'component_name' => '<string>',
        'payload_name' => '<string>',
        'kind' => '<string>',
        'xgress_id' => '<string>'
    ],
    'field_mappings' => [
        [
                'source_field' => '<string>',
                'destination_field' => '<string>',
                'notes' => '<string>'
        ]
    ],
    'namespace' => '<string>',
    'reason' => '<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://{hostname}.gable.ai/v0/experimental/edges"

	payload := strings.NewReader("{\n  \"source\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"destination\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"field_mappings\": [\n    {\n      \"source_field\": \"<string>\",\n      \"destination_field\": \"<string>\",\n      \"notes\": \"<string>\"\n    }\n  ],\n  \"namespace\": \"<string>\",\n  \"reason\": \"<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://{hostname}.gable.ai/v0/experimental/edges")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"source\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"destination\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"field_mappings\": [\n    {\n      \"source_field\": \"<string>\",\n      \"destination_field\": \"<string>\",\n      \"notes\": \"<string>\"\n    }\n  ],\n  \"namespace\": \"<string>\",\n  \"reason\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/edges")

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  \"source\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"destination\": {\n    \"component_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"component_name\": \"<string>\",\n    \"payload_name\": \"<string>\",\n    \"kind\": \"<string>\",\n    \"xgress_id\": \"<string>\"\n  },\n  \"field_mappings\": [\n    {\n      \"source_field\": \"<string>\",\n      \"destination_field\": \"<string>\",\n      \"notes\": \"<string>\"\n    }\n  ],\n  \"namespace\": \"<string>\",\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "edge": {
    "source": {
      "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "component_name": "<string>",
      "payload_name": "<string>",
      "kind": "<string>",
      "xgress_id": "<string>"
    },
    "destination": {
      "component_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "component_name": "<string>",
      "payload_name": "<string>",
      "kind": "<string>",
      "xgress_id": "<string>"
    },
    "field_mappings": [
      {
        "source_field": "<string>",
        "destination_field": "<string>",
        "notes": "<string>"
      }
    ],
    "id": "<string>",
    "kind": "cross_service",
    "namespace": "<string>"
  }
}
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
namespace
string

Optional namespace to scope the new edge.

Body

application/json

A cross-service edge connecting two components. This schema is used for both read (GET) and write (POST/PUT) operations to enable round-trip editing. Fields marked readOnly are returned by GET but ignored on POST/PUT. Fields marked writeOnly are accepted on POST/PUT but not returned in GET.

​
source
object
required

One side (source or destination) of a cross-service edge.

​
destination
object
required

One side (source or destination) of a cross-service edge.

​
field_mappings
object[]
required

Field-level mappings captured on this edge.

Minimum array length: 1
​
namespace
string

The namespace this edge belongs to.

​
reason
string
write-only

Optional reason for creating or updating this edge (stored in audit trail, not returned in GET).

Response

Edge created successfully

​
edge
object
required

A cross-service edge connecting two components. This schema is used for both read (GET) and write (POST/PUT) operations to enable round-trip editing. Fields marked readOnly are returned by GET but ignored on POST/PUT. Fields marked writeOnly are accepted on POST/PUT but not returned in GET.