---
updatedAt: 2025-10-08T18:31:19.000Z
agentTools:
  projectIndex: https://docs.uplynk.com/llms.txt
---

# Create a slicer

Create a new live Cloud Slicer instance. You can configure ingest settings, region, protocol, source, and metadata. This Slicer will handle live input streams and initiate slicing based on the provided configuration.

## Sample Use Cases
- Spin up a new live encoder for an upcoming event.
- Set region and protocol preferences for latency or redundancy.
- Automatically assign ingest settings via API.

## Authentication
```
API Scopes:
  - video.services.slicer.cloudslicer.live:write
```

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "title": "v4, CSL Only, Uplynk Environment",
    "description": "Public facing APIs served out through Services.",
    "version": "1.0.0"
  },
  "tags": [
    {
      "name": "Cloud Slicers Live"
    }
  ],
  "paths": {
    "/ingest/cloud-slicers/live/slicers": {
      "post": {
        "summary": "Create a slicer",
        "deprecated": false,
        "description": "Create a new live Cloud Slicer instance. You can configure ingest settings, region, protocol, source, and metadata. This Slicer will handle live input streams and initiate slicing based on the provided configuration.\n\n## Sample Use Cases\n- Spin up a new live encoder for an upcoming event.\n- Set region and protocol preferences for latency or redundancy.\n- Automatically assign ingest settings via API.\n\n## Authentication\n```\nAPI Scopes:\n  - video.services.slicer.cloudslicer.live:write\n```",
        "operationId": "create_live_cloud_slicer",
        "tags": [
          "Cloud Slicers Live"
        ],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "region": {
                    "$ref": "#/components/schemas/csl_slicer_region_code"
                  },
                  "protocol": {
                    "$ref": "#/components/schemas/csl_protocol"
                  },
                  "plugin": {
                    "$ref": "#/components/schemas/csl_slicer_plugin"
                  },
                  "slicer_id": {
                    "$ref": "#/components/schemas/csl_slicer_id"
                  },
                  "source_ip": {
                    "$ref": "#/components/schemas/csl_slicer_source_ip"
                  },
                  "slicer_version": {
                    "$ref": "#/components/schemas/csl_slicer_version"
                  },
                  "target_state": {
                    "$ref": "#/components/schemas/csl_target_state"
                  },
                  "configuration": {
                    "$ref": "#/components/schemas/csl_slicer_configuration"
                  },
                  "description": {
                    "$ref": "#/components/schemas/csl_slicer_description"
                  },
                  "encoding_profile_id": {
                    "type": "string",
                    "description": "Encoding profile ID to assign to the slicer. If unspecified, will use the account's default profile."
                  },
                  "rist_profile": {
                    "$ref": "#/components/schemas/csl_protocol_rist_profile"
                  }
                },
                "required": [
                  "region",
                  "protocol",
                  "slicer_id"
                ]
              },
              "example": {
                "region": "us-west-2",
                "protocol": "SRT",
                "slicer_id": "Second",
                "source_ip": "0.0.0.0",
                "configuration": "description:Test1",
                "description": "Second Slicer"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "successful operation initiation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "@id": {
                      "type": "string",
                      "examples": [
                        "/api/v4/ingest/cloud-slicers/live/slicers"
                      ]
                    },
                    "@type": {
                      "type": "string",
                      "examples": [
                        "LiveCloudSlicer"
                      ]
                    },
                    "id": {
                      "$ref": "#/components/schemas/csl_slicer_id"
                    },
                    "configuration": {
                      "$ref": "#/components/schemas/csl_slicer_configuration"
                    },
                    "source_ip": {
                      "$ref": "#/components/schemas/csl_slicer_source_ip"
                    },
                    "slicer_version": {
                      "description": "Slicer version. Use the slicer versions list endpoint for available versions.",
                      "$ref": "#/components/schemas/csl_slicer_version"
                    },
                    "encoding_profile_id": {
                      "type": "string",
                      "description": "GUID representing an encoding profile for the slicer."
                    },
                    "region": {
                      "$ref": "#/components/schemas/csl_slicer_region_code"
                    },
                    "protocol": {
                      "$ref": "#/components/schemas/csl_protocol"
                    },
                    "rist_profile": {
                      "$ref": "#/components/schemas/csl_protocol_rist_profile"
                    },
                    "streaming_url": {
                      "type": "string",
                      "description": "The ingest URL to which a stream is sent.",
                      "readOnly": true
                    },
                    "slicer_api_url": {
                      "type": "string",
                      "description": "Live Slicer API URL to which slicer API commands can be issued. See [here](https://docs.uplynk.com/reference/live-slicer) for more information.",
                      "readOnly": true
                    },
                    "passphrase": {
                      "type": "string",
                      "description": "Passphrase used to encrypt the connection between a sender (encoder) and a receiver (decoder).",
                      "readOnly": true
                    },
                    "target_state": {
                      "$ref": "#/components/schemas/csl_target_state"
                    },
                    "plugin": {
                      "$ref": "#/components/schemas/csl_slicer_plugin"
                    },
                    "created_at": {
                      "$ref": "#/components/schemas/datetime-iso-8601",
                      "description": "Slicer creation date time UTC string."
                    },
                    "description": {
                      "$ref": "#/components/schemas/csl_slicer_description"
                    },
                    "thumb_url": {
                      "type": "string",
                      "description": "URL for thumbnail display.",
                      "readOnly": true
                    }
                  },
                  "required": [
                    "@id",
                    "@type",
                    "id",
                    "configuration",
                    "encoding_profile_id",
                    "protocol",
                    "streaming_url",
                    "slicer_api_url"
                  ]
                }
              }
            },
            "headers": {}
          },
          "400": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "@type": {
                      "type": "string",
                      "const": "Error"
                    },
                    "code": {
                      "type": "string",
                      "const": "bad_request"
                    },
                    "status_code": {
                      "type": "integer",
                      "const": 400
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "@type",
                    "code",
                    "status_code",
                    "title"
                  ]
                },
                "example": {
                  "@type": "Error",
                  "code": "bad_request",
                  "status_code": 400,
                  "title": "Bad Request",
                  "description": "The request has one or more errors and cannot be processed"
                }
              }
            },
            "headers": {}
          },
          "401": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "msg": {
                      "type": "string"
                    },
                    "error": {
                      "type": "integer",
                      "const": 1
                    }
                  },
                  "required": [
                    "msg",
                    "error"
                  ]
                },
                "example": {
                  "msg": "The request did not include a required authentication component",
                  "error": 1
                }
              }
            },
            "headers": {}
          },
          "403": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "@type": {
                      "type": "string",
                      "const": "Error"
                    },
                    "code": {
                      "type": "string",
                      "const": "forbidden"
                    },
                    "status_code": {
                      "type": "integer",
                      "const": 403
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "@type",
                    "status_code",
                    "title",
                    "code"
                  ]
                },
                "example": {
                  "@type": "Error",
                  "code": "forbidden",
                  "status_code": 403,
                  "title": "Forbidden",
                  "description": "The request has failed authorization checks"
                }
              }
            },
            "headers": {}
          },
          "422": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "@type": {
                      "type": "string",
                      "const": "Error"
                    },
                    "code": {
                      "type": "string",
                      "const": "unprocessable_entity"
                    },
                    "status_code": {
                      "type": "integer",
                      "const": 422
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "@type",
                    "status_code",
                    "title",
                    "code"
                  ]
                },
                "example": {
                  "@type": "Error",
                  "code": "unprocessable_entity",
                  "status_code": 422,
                  "title": "Unprocessable Entity",
                  "description": "The request and its body are valid and parseable, but are malformed in a semantic way (missing data, incorrect structure)"
                }
              }
            },
            "headers": {}
          }
        },
        "security": [
          {
            "pre_signed_jwt": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "datetime-iso-8601": {
        "type": "string",
        "format": "date-time",
        "description": "Simplified extended ISO format date [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)",
        "examples": [
          "2022-10-27T15:22:09.017Z"
        ]
      },
      "csl_protocol": {
        "type": "string",
        "description": "Slicer input protocol.",
        "enum": [
          "SRT",
          "RTMP",
          "RIST"
        ]
      },
      "csl_protocol_rist_profile": {
        "type": "string",
        "enum": [
          "SIMPLE",
          "MAIN"
        ],
        "description": "RIST profile. Only applicable to RIST protocol."
      },
      "csl_slicer_configuration": {
        "type": "string",
        "description": "Line delimited Slicer configuration. See [here](https://docs.uplynk.com/docs/on-prem-slicer#configuration-file-settings) for a list of available parameters.",
        "examples": [
          "description:asset_description\\nprogID:1\\npids:481,482,483,500\\naudio_lang_482:en\\naudio_desc_482:primary\\naudio_lang_483:es\\naudio_desc_483:secondary\\npreview:on\\nlivepreview_with_audio:yes\\nautoexpire_age:168"
        ]
      },
      "csl_slicer_description": {
        "type": "string",
        "description": "Description of the slicer.",
        "examples": [
          "Optional slicer notes/description"
        ]
      },
      "csl_slicer_id": {
        "type": "string",
        "description": "Unique identifier for the cloud slicer.",
        "examples": [
          "up_west_pa1"
        ]
      },
      "csl_slicer_plugin": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Slicer plugin ID.",
            "examples": [
              "tennis-scte35"
            ]
          },
          "version": {
            "type": "string",
            "description": "Version of the chosen slicer plugin.",
            "examples": [
              "1.0"
            ]
          }
        }
      },
      "csl_slicer_region_code": {
        "type": "string",
        "description": "The geographic region in which the slicer will run.",
        "enum": [
          "us-west-2",
          "us-east-1",
          "us-east-2",
          "eu-central-1"
        ]
      },
      "csl_slicer_source_ip": {
        "type": "string",
        "description": "Source IP address whitelist. Set to `0.0.0.0` to allow receiving a feed from any sender.",
        "examples": [
          "54.12.43.12",
          "0.0.0.0"
        ],
        "default": "0.0.0.0"
      },
      "csl_slicer_version": {
        "type": "string",
        "description": "Slicer software version. Use the `List versions` endpoint for available versions.",
        "examples": [
          "250210.04.01"
        ]
      },
      "csl_target_state": {
        "type": "string",
        "description": "Desired slicer state.",
        "enum": [
          "Ready",
          "Stopped"
        ]
      }
    },
    "securitySchemes": {
      "pre_signed_jwt": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Auth-Uplynk-JWT",
        "description": "JWT generated using private key\n\nRequired Fields:\n  * owner_id - current owner id\n  * scope - array of permissions\n  * token_id - id of private key stored in CMS\n"
      }
    }
  },
  "servers": [
    {
      "url": "https://services.uplynk.com/api/v4",
      "description": "Uplynk Services"
    }
  ],
  "security": [
    {
      "pre_signed_jwt": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
````