Set the stream title.
Set the title of the currently streaming content.
Authorizations:
Request Body schema: application/json
string or integer or object or boolean |
Responses
Request samples
- Payload
{- "value": "Streaming my favorite game, Desert Bus."
}Response samples
- 200
{- "success": true,
- "message": "context specific success message"
}Send a user chat message.
Send a chat message on behalf of a user. Could be a bot name or a real user.
+Request samples
- Payload
{- "value": "Streaming my favorite game, Desert Bus."
}Response samples
- 200
{- "success": true,
- "message": "context specific success message"
}Send a user chat message.
Send a chat message on behalf of a user. Could be a bot name or a real user.
Authorizations:
Request Body schema: application/json
| user | string The user you want to send this message as. |
| body | string The message text that will be sent as the user. |
Responses
Request samples
- Payload
{- "user": "string",
- "body": "string"
}Response samples
- 200
{- "success": true,
- "message": "sent"
}Send a system chat message.
Send a chat message on behalf of the system/server.
Authorizations:
Request Body schema: application/json
| body | string The message text that will be sent as the system user. |
Responses
Request samples
- Payload
{- "body": "string"
}Response samples
- 200
{- "success": true,
- "message": "sent"
}Send a chat action.
Send an action that took place to the chat.
Authorizations:
Request Body schema: application/json
| body required | string The message text that will be sent as the system user. |
| author | string An optional user name that performed the action. |
Responses
Request samples
- Payload
{- "body": "rolled a 15 on the dice",
- "author": "JohnSmith"
}Response samples
- 200
{- "success": true,
- "message": "sent"
}Create an access token.
Create a single access token that has access to the access scopes provided.
Authorizations:
Request Body schema: application/json
| name | string The human-readable name to give this access token. |
| scopes | Array of strings |
Responses
Request samples
- Payload
{- "name": "string",
- "scopes": [
- "string"
]
}Response samples
- 200
{- "name": "your new token",
- "token": "zG2xO-mHTFnelCp5xaIkYEFWcPhoOswOSRmFC1BkI="
}Delete an access token.
Delete a single access token.
Authorizations:
Request Body schema: application/json
| token | string The token to delete |
Responses
Request samples
- Payload
{- "token": "string"
}Response samples
- 200
{- "success": true,
- "message": "deleted token"
}Set external action URLs.
Set a collection of external action URLs that are displayed in the UI.
+Authorizations:
Request Body schema: application/json
| url | string URL of the external action content. + |
| title | string The title to put on the external action button. + |
| description | string Optional additional description to display in the UI. + |
| icon | string The URL to an image to place on the external action button. + |
| color | string Optional color to use for drawing the action button. + |
| openExternally | boolean If set this action will open in a new browser tab instead of an internal modal. + |
Responses
Request samples
- Payload
[- {
- "url": "string",
- "title": "string",
- "description": "string",
- "icon": "string",
- "color": "string",
- "openExternally": true
}
]Return a list of currently connected clients
Return a list of currently connected clients with optional geo details.
Authorizations:
Responses
Response samples
- 200
[- {
- "connectedAt": "2020-10-06T23:20:44.588649-07:00",
- "messageCount": 3,
- "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36",
- "ipAddress": "172.217.164.110",
- "username": "coolperson42",
- "clientID": "2ba20dd34f911c198df3218ddc64c740",
- "geo": {
- "countryCode": "US",
- "regionName": "California",
- "timeZone": "America/Los_Angeles"
}
}
]Update the visibility of chat messages.
Pass an array of IDs you want to change the chat visibility of.
+Response samples
- 200
[- {
- "connectedAt": "2020-10-06T23:20:44.588649-07:00",
- "messageCount": 3,
- "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.89 Safari/537.36",
- "ipAddress": "172.217.164.110",
- "username": "coolperson42",
- "clientID": "2ba20dd34f911c198df3218ddc64c740",
- "geo": {
- "countryCode": "US",
- "regionName": "California",
- "timeZone": "America/Los_Angeles"
}
}
]Update the visibility of chat messages.
Pass an array of IDs you want to change the chat visibility of.
Authorizations:
Request Body schema: application/json
| visible | boolean Are these messages visible. |
| idArray | Array of strings |
Responses
Request samples
- Payload
{- "visible": true,
- "idArray": [
- "string"
]
}Response samples
- 200
{- "success": true,
- "message": "context specific success message"
}Response samples
- 200
{- "name": "string",
- "summary": "string",
- "logo": "string",
- "tags": [
- "string"
], - "extraPageContent": "<p>This page is <strong>super</strong> cool!",
- "version": "Owncast v0.0.3-macOS (ef3796a033b32a312ebf5b334851cbf9959e7ecb)"
}Current Status
This endpoint is used to discover when a server is broadcasting, the number of active viewers as well as other useful information for updating the user interface.
-Responses
Response samples
- 200
{- "lastConnectTime": "2020-10-03T21:36:22-05:00",
- "lastDisconnectTime": null,
- "online": true,
- "overallMaxViewerCount": 420,
- "sessionMaxViewerCount": 12,
- "viewerCount": 7
}Yellow Pages Information
Information to be used in the Yellow Pages service, a global directory of Owncast servers.
-Responses
Response samples
- 200
{- "name": "string",
- "description": "string",
- "logo": "string",
- "nsfw": true,
- "tags": [
- "string"
], - "online": true,
- "viewerCount": 0,
- "overallMaxViewerCount": 0,
- "sessionMaxViewerCount": 0,
- "lastConnectTime": "2019-08-24T14:15:22Z"
}