Skip to main content
POST
/
execution-layers
Post Create Execution Layer
curl --request POST \
  --url https://app.docs.bynesoft.com/api/users/execution-layers \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "sourceFabric": {
    "config": {
      "body": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "maxLength": 100,
            "minLength": 1,
            "type": "string"
          },
          "age": {
            "format": "int32",
            "maximum": 150,
            "minimum": 0,
            "type": [
              "integer",
              "null"
            ]
          },
          "birth-date": {
            "format": "date",
            "type": "string"
          },
          "address": {
            "items": false,
            "prefixItems": [
              {
                "type": "number"
              },
              {
                "type": "string"
              },
              {
                "enum": [
                  "Street",
                  "Avenue",
                  "Boulevard",
                  "Lane",
                  "Drive"
                ]
              },
              {
                "enum": [
                  "NW",
                  "NE",
                  "SW",
                  "SE",
                  "N",
                  "S",
                  "E",
                  "W"
                ]
              }
            ],
            "type": "array"
          },
          "contact-info": {
            "additionalProperties": false,
            "properties": {
              "email": {
                "format": "email",
                "type": "string"
              },
              "phone": {
                "pattern": "^[0-9]{3}-[0-9]{3}-[0-9]{4}$",
                "type": "string"
              }
            },
            "required": [
              "email"
            ],
            "type": "object"
          },
          "employment-status": {
            "enum": [
              "Employed",
              "Unemployed",
              "Student",
              "Retired"
            ],
            "type": "string"
          },
          "social-security-number": {
            "description": "Optional field representing a U.S. Social Security Number",
            "pattern": "^[0-9]{3}-[0-9]{2}-[0-9]{4}$",
            "type": "string"
          }
        },
        "required": [
          "name",
          "age",
          "birth-date",
          "address",
          "contact-info",
          "employment-status"
        ],
        "type": "object"
      },
      "headers": {
        "Authorization": "Bearer token",
        "Content-Type": "application/json",
        "Custom-Header": "CustomValue"
      },
      "method": "POST",
      "parameters": {
        "items": {
          "properties": {
            "queryParam": {
              "default": "default_value",
              "description": "A query parameter",
              "type": "string"
            },
            "anotherQueryParam": {
              "description": "Another query parameter with enum",
              "enum": [
                "value1",
                "value2"
              ],
              "type": "string"
            }
          },
          "required": [
            "queryParam"
          ],
          "type": "object"
        },
        "type": "array"
      },
      "url": "https://api.example.com/data"
    },
    "name": "apiFunction"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "dateCreated": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
name
string
required
Required string length: 1 - 50
​
description
string
required
Required string length: 1 - 250
​
sourceFabric
object
required
Examples:
{
  "config": {
    "body": {
      "additionalProperties": false,
      "properties": {
        "name": {
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "age": {
          "format": "int32",
          "maximum": 150,
          "minimum": 0,
          "type": ["integer", "null"]
        },
        "birth-date": { "format": "date", "type": "string" },
        "address": {
          "items": false,
          "prefixItems": [
            { "type": "number" },
            { "type": "string" },
            {
              "enum": [
                "Street",
                "Avenue",
                "Boulevard",
                "Lane",
                "Drive"
              ]
            },
            {
              "enum": ["NW", "NE", "SW", "SE", "N", "S", "E", "W"]
            }
          ],
          "type": "array"
        },
        "contact-info": {
          "additionalProperties": false,
          "properties": {
            "email": { "format": "email", "type": "string" },
            "phone": {
              "pattern": "^[0-9]{3}-[0-9]{3}-[0-9]{4}$",
              "type": "string"
            }
          },
          "required": ["email"],
          "type": "object"
        },
        "employment-status": {
          "enum": [
            "Employed",
            "Unemployed",
            "Student",
            "Retired"
          ],
          "type": "string"
        },
        "social-security-number": {
          "description": "Optional field representing a U.S. Social Security Number",
          "pattern": "^[0-9]{3}-[0-9]{2}-[0-9]{4}$",
          "type": "string"
        }
      },
      "required": [
        "name",
        "age",
        "birth-date",
        "address",
        "contact-info",
        "employment-status"
      ],
      "type": "object"
    },
    "headers": {
      "Authorization": "Bearer token",
      "Content-Type": "application/json",
      "Custom-Header": "CustomValue"
    },
    "method": "POST",
    "parameters": {
      "items": {
        "properties": {
          "queryParam": {
            "default": "default_value",
            "description": "A query parameter",
            "type": "string"
          },
          "anotherQueryParam": {
            "description": "Another query parameter with enum",
            "enum": ["value1", "value2"],
            "type": "string"
          }
        },
        "required": ["queryParam"],
        "type": "object"
      },
      "type": "array"
    },
    "url": "https://api.example.com/data"
  },
  "name": "apiFunction"
}
{
  "config": {
    "authorization": {
      "apiKey": "your-api-key",
      "searchEngineId": "your-search-engine-id"
    },
    "siteFilter": ["example.com", "anotherexample.com"]
  },
  "name": "googleSearch"
}
{
  "config": {
    "kbId": "kb-id",
    "searchOptions": {
      "cosineSimilarityScoreThreshold": 0.5,
      "fileIdsFilter": ["file-id-1", "file-id-2"],
      "hybrid": {
        "enabled": true,
        "keywords": ["keyword-1", "keyword-2"]
      }
    }
  },
  "name": "knowledgeBase"
}

Response

Successful Response

​
id
string
required
​
name
string
required
​
dateCreated
string
required
⌘I