Kaltura · Example Payload

Service_Session_Action_Start_Post

Start a session with Kaltura's server. The result KS is the session key that you should pass to all services that requires a ticket.

session

Service_Session_Action_Start_Post is an example object payload from Kaltura, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

pathmethodoperationIdsummarydescriptiontagsparametersresponses

Example Payload

Raw ↑
{
  "path": "/service/session/action/start",
  "method": "POST",
  "operationId": "session.start",
  "summary": "",
  "description": "Start a session with Kaltura's server.\n\nThe result KS is the session key that you should pass to all services that requires a ticket.",
  "tags": [
    "session"
  ],
  "parameters": [
    {
      "$ref": "#/parameters/format"
    },
    {
      "$ref": "#/parameters/clientTag"
    },
    {
      "$ref": "#/parameters/partnerId"
    },
    {
      "$ref": "#/parameters/language"
    },
    {
      "$ref": "#/parameters/responseProfile"
    }
  ],
  "responses": {
    "200": {
      "description": "Success"
    },
    "x-Errors": {
      "description": "* `START_SESSION_ERROR`: Error while starting session for partner [@PID@]"
    }
  }
}