{% extends "base.htm" %} {% block title %}API Documentation{% endblock %} {% block content %}

API Documentation

Bot list

Show a list of all bots.

URL: /api/bots

Method: GET

Auth required: NO

Success Response

Code: 200 OK

Content example

[
  {
    "name": "MusicBot",
    "state": "Playing",
    "volume": 0.5,
    "position": {
      "secs": 10,
      "nanos": 63573687
    },
    "currently_playing": {
      "url": "<temp_url>",
      "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "title": "Rick Astley - Never Gonna Give You Up (Video)",
      "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
      "duration": {
        "secs": 212,
        "nanos": 0
      }
    },
    "playlist": [
      {
        "url": "<temp_url>",
        "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        "title": "Rick Astley - Never Gonna Give You Up (Video)",
        "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
        "duration": {
          "secs": 212,
          "nanos": 0
        }
      }
    ]
  }
]

Show Bot

Show a specific bot.

URL: /api/bots/:botname

Method: GET

Auth required: NO

Success Response

Code: 200 OK

Content example

{
  "name": "MusicBot",
  "state": "Playing",
  "volume": 0.5,
  "position": {
    "secs": 142,
    "nanos": 690911766
  },
  "currently_playing": {
    "url": "<temp_url>",
    "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "title": "Rick Astley - Never Gonna Give You Up (Video)",
    "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
    "duration": {
      "secs": 212,
      "nanos": 0
    }
  },
  "playlist": [
    {
      "url": "<temp_url>",
      "webpage_url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "title": "Rick Astley - Never Gonna Give You Up (Video)",
      "thumbnail": "https://i.ytimg.com/vi/dQw4w9WgXcQ/maxresdefault.jpg",
      "duration": {
        "secs": 212,
        "nanos": 0
      }
    }
  ]
}

Error Response

Condition: If ':botname' is not connected to TeamSpeak.

Code: 404 NOT FOUND

Content: 
{
  "error": "Not Found",
  "description": "The requested resource was not found"
}
{% endblock %}