API reference › Videos

GET /videos

Returns the videos.

Resource URL

https://api.toornament.com/organizer/v2/videos

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:view scope (see Authorization)

  • Range
    string

    A range of requested items using the videos unit. The size of the range can not exceed 50. (see Pagination)

    Example: videos=0-49

Query Parameters

  • participant_ids
    array

    One or several participant ids to filter.

    Example: 618965765764577354,618931468547654563

  • match_ids
    array

    A list of match ids to filter.

    Example: 618954615761465416,234819413984183454

  • tournament_ids
    array

    Only return videos for the given list of tournaments.

    Example: 618965416546776434,618975467354349191

  • disciplines
    array

    Only return videos for the tournaments with the discipline.

    Example: leagueoflegends,fifa19

  • category
    string

    The category of the videos.

    Possible values: replay, highlight, bonus

  • languages
    array

    One or several language to filter.

    Example: en,fr

  • sort
    string

    Sorts the collection in a particular order. "created_asc" sorts the videos from the oldest to the most recent one; "created_desc" sorts the videos from the most recent to the oldest one.

    Possible values: created_asc, created_desc

    Default: created_asc

Request Body

This endpoint does not require a request body.

Response

[206] Videos retrieved.

Example
[
    {
        "name": "Game 1: TSM vs. EnVyUs",
        "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
        "language": "en",
        "category": "replay",
        "match_id": "378426939508809728",
        "tournament_id": "378426939508809728",
        "id": "863174896574643814"
    }
]
Structure (collection)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

  • id
    string

    An identifier for a video.

    Example: "863174896574643814"

POST /videos

Creates a new video.

Resource URL

https://api.toornament.com/organizer/v2/videos

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Video data

Example
{
    "name": "Game 1: TSM vs. EnVyUs",
    "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
    "language": "en",
    "category": "replay",
    "match_id": "378426939508809728",
    "tournament_id": "378426939508809728"
}
Structure (object)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

Response

[201] Video created.

Example
{
    "name": "Game 1: TSM vs. EnVyUs",
    "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
    "language": "en",
    "category": "replay",
    "match_id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "id": "863174896574643814"
}
Structure (object)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

  • id
    string

    An identifier for a video.

    Example: "863174896574643814"

GET /videos/{id}

Returns a video identified with the given id with all organizer-specific data.

Resource URL

https://api.toornament.com/organizer/v2/videos/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:view scope (see Authorization)

Path parameters

  • id
    string

    The id of the video you want to retrieve data about.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Video retrieved.

Example
{
    "name": "Game 1: TSM vs. EnVyUs",
    "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
    "language": "en",
    "category": "replay",
    "match_id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "id": "863174896574643814"
}
Structure (object)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

  • id
    string

    An identifier for a video.

    Example: "863174896574643814"

PATCH /videos/{id}

Updates one or several fields of one of your videos.

Resource URL

https://api.toornament.com/organizer/v2/videos/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • id
    string

    The id of the video you want to retrieve data about.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Tournament data.

Example
{
    "name": "Game 1: TSM vs. EnVyUs",
    "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
    "language": "en",
    "category": "replay",
    "match_id": "378426939508809728",
    "tournament_id": "378426939508809728"
}
Structure (object)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

Response

[200] Success.

Example
{
    "name": "Game 1: TSM vs. EnVyUs",
    "url": "https:\/\/www.youtube.com\/watch?v=SI5QgDJkaSU",
    "language": "en",
    "category": "replay",
    "match_id": "378426939508809728",
    "tournament_id": "378426939508809728",
    "id": "863174896574643814"
}
Structure (object)
  • name
    string

    The title of the video.

    Max. length: 40 characters

    Example: "Game 1: TSM vs. EnVyUs"

  • url
    string

    The URL of the video.

    Max. length: 2,000 characters

    Example: "https://www.youtube.com/watch?v=SI5QgDJkaSU"

  • language
    string

    Language code of the video content in ISO 639-1 code

    Max. length: 2 characters

    Example: "en"

  • category
    string

    The category of the video.

    Possible values: replay, highlight, bonus

  • match_id
    string|null

    The match's identifier of this video.

    Example: "378426939508809728"

  • tournament_id
    string

    A unique identifier for the tournament.

    Example: "378426939508809728"

  • id
    string

    An identifier for a video.

    Example: "863174896574643814"

DELETE /videos/{id}

Deletes your video identified by the given id.

Resource URL

https://api.toornament.com/organizer/v2/videos/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:delete scope (see Authorization)

Path parameters

  • id
    string

    The id of the video you want to retrieve data about.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success.