POST

/api/v1/automation/synchronizer/text

Distribute text or random numbers across synchronized windows

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/automation/synchronizer/text" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: runtime:control, sync:control

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required
`target_id`	`string`	Yes
`selector`	`string`	No
`frames`	`array`	No
`include_source`	`boolean`	No
`append`	`boolean`	No
`mode`	`union`	Yes
`text`	`string`	No
`minimum`	`integer`	No
`maximum`	`integer`	No
`unique`	`boolean`	No
`key_min_ms`	`integer`	No
`key_max_ms`	`integer`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "target_id",
          "mode"
        ],
        "properties": {
          "target_id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128
          },
          "selector": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4000
          },
          "frames": {
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 4000
            },
            "maxItems": 16
          },
          "include_source": {
            "type": "boolean"
          },
          "append": {
            "type": "boolean"
          },
          "mode": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "same"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "lines"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "shuffle"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "random"
                ]
              }
            ]
          },
          "text": {
            "type": "string",
            "maxLength": 210000
          },
          "minimum": {
            "type": "integer",
            "minimum": -1000000000,
            "maximum": 1000000000
          },
          "maximum": {
            "type": "integer",
            "minimum": -1000000000,
            "maximum": 1000000000
          },
          "unique": {
            "type": "boolean"
          },
          "key_min_ms": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          },
          "key_max_ms": {
            "type": "integer",
            "minimum": 0,
            "maximum": 2000
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "results"
        ],
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "profile_id",
                "ok"
              ],
              "properties": {
                "profile_id": {
                  "type": "string"
                },
                "ok": {
                  "type": "boolean"
                },
                "error": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Text oder Zufallszahlen auf synchronisierte Fenster verteilen",
  "tags": [
    "Automation"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "target_id",
            "mode"
          ],
          "properties": {
            "target_id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 128
            },
            "selector": {
              "type": "string",
              "minLength": 1,
              "maxLength": 4000
            },
            "frames": {
              "type": "array",
              "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 4000
              },
              "maxItems": 16
            },
            "include_source": {
              "type": "boolean"
            },
            "append": {
              "type": "boolean"
            },
            "mode": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "same"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "lines"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "shuffle"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "random"
                  ]
                }
              ]
            },
            "text": {
              "type": "string",
              "maxLength": 210000
            },
            "minimum": {
              "type": "integer",
              "minimum": -1000000000,
              "maximum": 1000000000
            },
            "maximum": {
              "type": "integer",
              "minimum": -1000000000,
              "maximum": 1000000000
            },
            "unique": {
              "type": "boolean"
            },
            "key_min_ms": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2000
            },
            "key_max_ms": {
              "type": "integer",
              "minimum": 0,
              "maximum": 2000
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "runtime:control",
    "sync:control"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "results"
            ],
            "properties": {
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "profile_id",
                    "ok"
                  ],
                  "properties": {
                    "profile_id": {
                      "type": "string"
                    },
                    "ok": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}