diff --git a/docs/api/index.html b/docs/api/index.html index de91038db..5346a5adc 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -443,7 +443,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in ">

These APIs are specifically exposed for building third party applications or tooling. They use auth tokens to authenticate and are designed to be stable and reliable.

Send a system message to the chat

Authorizations:
BearerAuth
Request Body schema: application/json

The content of the system message

-
timestamp
string
type
string
id
string
body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Send a system message to a single client

Authorizations:
BearerAuth
path Parameters
clientId
required
integer
http://localhost:8080/api/integrations/chat/system

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Send a system message to a single client

Authorizations:
BearerAuth
path Parameters
clientId
required
integer

The ID of the specified client

Request Body schema: application/json
timestamp
string
type
string
id
string
body
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:
BearerAuth
Request Body schema: application/json
timestamp
string
type
string
id
string
object (User)
hiddenAt
string
clientId
integer
body
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:
BearerAuth
Request Body schema: application/json
body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "user": {
    },
  • "hiddenAt": "string",
  • "clientId": 0,
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendIntegrationChatMessageOptions

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendIntegrationChatMessageOptions

Responses

Send a user action to chat

Authorizations:
BearerAuth
Request Body schema: application/json
timestamp
string
type
string
id
string
body
string

Responses

Send a user action to chat

Authorizations:
BearerAuth
Request Body schema: application/json
body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Hide chat message

Authorizations:
BearerAuth
Request Body schema: application/json
idArray
Array of strings
visible
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Hide chat message

Authorizations:
BearerAuth
Request Body schema: application/json
idArray
Array of strings
visible
boolean

Responses

Send a system message to the chat

Authorizations:
BearerAuth
Request Body schema: application/json

The content of the system message

-
timestamp
string
type
string
id
string
body
string

Responses

body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendSystemMessageOptions

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendSystemMessageOptions

Responses

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:
BearerAuth
Request Body schema: application/json
timestamp
string
type
string
id
string
object (User)
hiddenAt
string
clientId
integer
body
string

Responses

Send a message to chat as a specific 3rd party bot/integration based on its access token

Authorizations:
BearerAuth
Request Body schema: application/json
body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "user": {
    },
  • "hiddenAt": "string",
  • "clientId": 0,
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendIntegrationChatMessageOptions

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendIntegrationChatMessageOptions

Responses

Send a user action to chat

Authorizations:
BearerAuth
Request Body schema: application/json
timestamp
string
type
string
id
string
body
string

Responses

Send a user action to chat

Authorizations:
BearerAuth
Request Body schema: application/json
body
string

Responses

Request samples

Content type
application/json
{
  • "timestamp": "string",
  • "type": "string",
  • "id": "string",
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendChatActionOptions

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

SendChatActionOptions

Responses