Owncast

Generated Owncast CLI and agent Skill for live-stream administration and integrations.

$ owncast search "list webhooks" --json

CLI binaries 6 platform builds

Skill Included in CLI

Source refs 1 pinned inputs

Smoke intent list webhooks

01 Schema owncast commands schema --json

02 Catalog owncast commands --json

03 Search owncast search "list webhooks" --json

Recipe structure

Files

10 files

builds/owncast.json json

{
  "schema_version": 1,
  "recipe": "owncast",
  "cli_name": "owncast",
  "generated_at": "2026-08-21T06:46:41.071Z",
  "lathe_version": "lathe v0.5.2 (none, unknown)",
  "gate": {
    "verdict": "GO",
    "generated_at": "2026-08-21T06:46:41.071Z",
    "lathe_version": "lathe v0.5.2 (none, unknown)",
    "command_count": 137,
    "group_count": 4,
    "skill_included": true,
    "warnings": [
      "W2"
    ]
  },
  "source_refs": [
    {
      "name": "owncast_api",
      "display_name": "owncast_api",
      "backend": "openapi3",
      "repo_url": "https://github.com/owncast/owncast",
      "pinned_tag": "4d04992fad51cceca206b71f24d129cfe7dcc90e",
      "files": [
        "openapi.yaml"
      ]
    }
  ],
  "outputs": {
    "catalog": null,
    "skill": "skills/owncast",
    "cli_artifacts": [
      {
        "os": "darwin",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "owncast",
        "path": "downloads/owncast-darwin-arm64.tar.gz",
        "size": 3679707,
        "sha256": "sha256:aa9b4fc69167f98bea3988759f2fba49403736480f21aad4d336cee62c2098cb"
      },
      {
        "os": "darwin",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "owncast",
        "path": "downloads/owncast-darwin-amd64.tar.gz",
        "size": 3969425,
        "sha256": "sha256:a7bd51f1a9460c3550e56aa26294cfa9739c2fc94e0eb8a32082a122161f76a8"
      },
      {
        "os": "linux",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "owncast",
        "path": "downloads/owncast-linux-amd64.tar.gz",
        "size": 3908106,
        "sha256": "sha256:ad96092585d270496302d560f969542a9b07b77d4e7c6ff53ede557c6abaa38d"
      },
      {
        "os": "linux",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "owncast",
        "path": "downloads/owncast-linux-arm64.tar.gz",
        "size": 3544095,
        "sha256": "sha256:7dcd4da068b037f91984b863f229177180e25dabc451ea43049288fabbf4e1e3"
      },
      {
        "os": "windows",
        "arch": "amd64",
        "format": "tar.gz",
        "binary": "owncast.exe",
        "path": "downloads/owncast-windows-amd64.tar.gz",
        "size": 4025657,
        "sha256": "sha256:6fe690899bc6baaae3881ad6d7cfed28cdc6058e25718785b6058e38ba5b7a5f"
      },
      {
        "os": "windows",
        "arch": "arm64",
        "format": "tar.gz",
        "binary": "owncast.exe",
        "path": "downloads/owncast-windows-arm64.tar.gz",
        "size": 3608017,
        "sha256": "sha256:54b854c1bba617f8fa1bee37e8399ff6dd3274533f5c59ca766bc2c4095f6387"
      }
    ]
  }
}

recipes/owncast/README.md markdown

# Owncast

This recipe generates the `owncast` CLI and agent Skill for
[Owncast](https://github.com/owncast/owncast) live-stream administration,
webhooks, and integrations.

## API and authentication

Owncast admin endpoints use HTTP Basic authentication. Use the admin username
and stream key:

```sh
owncast auth login --hostname <host> --auth-type basic
owncast auth status --hostname <host>
```

## Install the Skill

```sh
owncast skill install --scope user --agent codex --yes
```

## Agent workflow

```sh
owncast commands --json
owncast search "list webhooks" --json
```

Use the returned command path with `owncast commands show` before execution.
Bump the pin in `specs/sources.yaml` when upgrading the Owncast API.

recipes/owncast/cli.yaml yaml

cli:
  name: owncast
  short: "Command-line tool for Owncast live streams"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /api/admin/status
    display:
      username_field: versionNumber
      fallback_field: streamTitle

recipes/owncast/lathe.yaml yaml

name: owncast
display_name: Owncast
cli_name: owncast
category: streaming
homepage: https://github.com/owncast/owncast
description: Generated Owncast CLI and agent Skill for live-stream administration and integrations.
maintainers:
  - github: samzong
auth:
  type: custom
  notes: >-
    Owncast admin endpoints use HTTP Basic authentication. Run
    `owncast auth login --hostname <host> --auth-type basic` with the admin
    username and stream key, then verify with `owncast auth status`.
smoke:
  intent: list webhooks
  expect: get-webhooks

recipes/owncast/specs/sources.yaml yaml

sources:
  owncast_api:
    default_hostname: localhost:8080
    repo_url: https://github.com/owncast/owncast
    # pinned to master HEAD as of 2026-07-26; bump when upgrading
    pinned_tag: 4d04992fad51cceca206b71f24d129cfe7dcc90e
    backend: openapi3
    openapi3:
      files:
        - openapi.yaml

skills/owncast/.lathe-skill text

generated by lathe codegen; safe to remove and regenerate

skills/owncast/SKILL.md markdown

---
name: owncast
description: >
  Use when operating the owncast generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# owncast CLI

Use this skill when a user asks you to operate `owncast`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `owncast search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `owncast commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `owncast auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$OWNCAST_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `owncast commands --json`: full generated command catalog.
- `owncast commands --include-hidden --json`: include hidden generated commands.
- `owncast commands show <path...> --json`: source of truth for one command.
- `owncast commands schema --json`: catalog schema version for parser compatibility.
- `owncast search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `owncast --version` or `owncast -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/owncast-api.md` for the `owncast_api` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

skills/owncast/agents/openai.yaml yaml

interface:
  display_name: "owncast CLI"
  short_description: "Use the owncast generated CLI"
  default_prompt: "Use $owncast to find and run the right owncast command."

skills/owncast/references/catalog.md markdown

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `owncast search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `owncast commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$OWNCAST_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `owncast commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `owncast commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `owncast auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$OWNCAST_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

skills/owncast/references/modules/owncast-api.md markdown

# Module `owncast_api`

## Source

- Backend: `openapi3`
- Default hostname: `localhost:8080`
- Repository: https://github.com/owncast/owncast
- Pinned tag: `4d04992fad51cceca206b71f24d129cfe7dcc90e`
- Files: `openapi.yaml`
- Resolved SHA: `4d04992fad51cceca206b71f24d129cfe7dcc90e`

## Chat

### `owncast chat get-user-details`

- Summary: Get a user's details
- HTTP: `GET /moderation/chat/user/{userId}`
- Auth: required
- Body: none
- Flags:
  - `--user-id` (path, required): The ID of the user to find
- Output: list path `connectedClients`; columns `id`, `connectedAt`, `geo`, `messageCount`, `userAgent`; response media `application/json`

## External

### `owncast external external-get-chat-messages`

- Summary: Get chat history
- HTTP: `GET /integrations/chat`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast external external-get-connected-chat-clients`

- Summary: Connected clients
- HTTP: `GET /integrations/clients`
- Auth: required
- Body: none
- Flags: none
- Output: columns `connectedAt`, `geo`, `messageCount`, `userAgent`; response media `application/json`

### `owncast external external-get-status`

- Summary: Get the server's status
- HTTP: `GET /integrations/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast external external-get-user-details`

- Summary: Get a user's details
- HTTP: `GET /integrations/moderation/chat/user/{userId}`
- Auth: required
- Body: none
- Flags:
  - `--user-id` (path, required): The ID of the user to find
- Output: list path `connectedClients`; columns `id`, `connectedAt`, `geo`, `messageCount`, `userAgent`; response media `application/json`

### `owncast external external-set-stream-title`

- Summary: Stream title
- HTTP: `POST /integrations/streamtitle`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast external external-update-message-visibility`

- Summary: Hide chat message
- HTTP: `POST /integrations/chat/messagevisibility`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast external send-chat-action`

- Summary: Send a user action to chat
- HTTP: `POST /integrations/chat/action`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast external send-integration-chat-message`

- Summary: Send a message to chat as a specific 3rd party bot/integration based on its access token
- HTTP: `POST /integrations/chat/send`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast external send-system-message`

- Summary: Send a system message to the chat
- HTTP: `POST /integrations/chat/system`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast external send-system-message-to-connected-client`

- Summary: Send a system message to a single client
- HTTP: `POST /integrations/chat/system/client/{clientId}`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
  - `--client-id` (path, required): The ID of the specified client

### `owncast external send-user-message`

- Summary: Send a user message to chat
- HTTP: `POST /integrations/chat/user`
- Auth: required
- Body: none
- Flags: none

## Internal

### `owncast internal add-federated-server`

- Summary: Add a federated server to follow
- HTTP: `POST /admin/federation/servers`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal approve-follower`

- Summary: Set the following state of a follower or follow request
- HTTP: `POST /admin/followers/approve`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal auto-update-force-quit`

- Summary: Force quit the server and restart it
- HTTP: `GET /admin/update/forcequit`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal auto-update-options`

- Summary: Return the auto-update features that are supported for this instance
- HTTP: `GET /admin/update/options`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal auto-update-start`

- Summary: Begin the auto-update
- HTTP: `GET /admin/update/start`
- Auth: required
- Body: none
- Flags: none
- Output: response media `text/plain`

### `owncast internal ban-ip-address`

- Summary: Ban an IP address
- HTTP: `POST /admin/chat/users/ipbans/create`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal create-external-api-user`

- Summary: Create a single access token
- HTTP: `POST /admin/accesstokens/create`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: list path `scopes`; response media `application/json`

### `owncast internal create-webhook`

- Summary: Create a single webhook
- HTTP: `POST /admin/webhooks/create`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: list path `events`; response media `application/json`

### `owncast internal delete-custom-emoji`

- Summary: Delete custom emoji
- HTTP: `POST /admin/emoji/delete`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal delete-external-api-user`

- Summary: Delete a single external API user
- HTTP: `POST /admin/accesstokens/delete`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal delete-prometheus-api`

- Summary: Endpoint to interface with Prometheus
- HTTP: `DELETE /admin/prometheus`
- Auth: required
- Body: none
- Flags: none

### `owncast internal delete-user`

- Summary: Permanently delete a user and all of their data
- HTTP: `POST /admin/users/delete`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal delete-webhook`

- Summary: Delete a single webhook
- HTTP: `POST /admin/webhooks/delete`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal disconnect-inbound-connection`

- Summary: Disconnect inbound stream
- HTTP: `GET /admin/disconnect`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-active-viewers`

- Summary: Get active viewers
- HTTP: `GET /admin/viewers`
- Auth: required
- Body: none
- Flags: none
- Output: columns `clientID`, `firstSeen`, `geo`, `ipAddress`, `userAgent`; response media `application/json`

### `owncast internal get-admin-federated-servers`

- Summary: Get all federated servers (admin), including pending requests
- HTTP: `GET /admin/federation/servers`
- Auth: required
- Body: none
- Flags: none
- Output: list path `servers`; columns `name`, `id`, `addedAt`, `followedAt`, `iri`, `isOnline`; response media `application/json`

### `owncast internal get-all-social-platforms`

- Summary: Get all social platforms
- HTTP: `GET /socialplatforms`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-blocked-and-rejected-followers`

- Summary: Get a list of rejected or blocked follows
- HTTP: `GET /admin/followers/blocked`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-chat-messages`

- Summary: Gets a list of chat messages
- HTTP: `GET /chat`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-chat-messages-admin`

- Summary: Get all chat messages for the admin, unfiltered
- HTTP: `GET /admin/chat/messages`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-connected-chat-clients`

- Summary: Get a detailed list of currently connected chat clients
- HTTP: `GET /admin/chat/clients`
- Auth: required
- Body: none
- Flags: none
- Output: columns `connectedAt`, `geo`, `messageCount`, `userAgent`; response media `application/json`

### `owncast internal get-custom-emoji-list`

- Summary: Get list of custom emojis supported in the chat
- HTTP: `GET /emoji`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `url`; response media `application/json`

### `owncast internal get-directory-followers`

- Summary: Get directories that are featuring/listing this server
- HTTP: `GET /admin/followers/directory`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-disabled-users`

- Summary: Get a list of disabled users
- HTTP: `GET /admin/chat/users/disabled`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `authenticated`, `createdAt`, `disabledAt`, `displayColor`, `displayName`; response media `application/json`

### `owncast internal get-external-api-users`

- Summary: Get all access tokens
- HTTP: `GET /admin/accesstokens`
- Auth: required
- Body: none
- Flags: none
- Output: columns `type`, `id`, `accessToken`, `createdAt`, `displayColor`, `displayName`; response media `application/json`

### `owncast internal get-feature-requests`

- Summary: Get pending requests from other servers to feature this server's stream
- HTTP: `GET /admin/federation/feature-requests`
- Auth: required
- Body: none
- Flags: none
- Output: list path `requests`; columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-federated-actions`

- Summary: Get a paginated list of federated activities
- HTTP: `GET /admin/federation/actions`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-federated-servers`

- Summary: Get list of federated servers
- HTTP: `GET /federation/servers`
- Auth: required
- Body: none
- Flags: none
- Output: list path `servers`; columns `name`, `id`, `addedAt`, `followedAt`, `iri`, `isOnline`; response media `application/json`

### `owncast internal get-followers`

- Summary: Gets the list of followers
- HTTP: `GET /followers`
- Auth: required
- Body: none
- Flags: none
- Output: list path `results`; columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-followers-admin`

- Summary: Get followers
- HTTP: `GET /admin/followers`
- Auth: required
- Body: none
- Flags: none
- Output: list path `results`; columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-hardware-stats`

- Summary: Get the current hardware stats
- HTTP: `GET /admin/hardwarestats`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-ip-address-bans`

- Summary: Get all banned IP addresses
- HTTP: `GET /admin/chat/users/ipbans`
- Auth: required
- Body: none
- Flags: none
- Output: columns `createdAt`, `ipAddress`, `notes`; response media `application/json`

### `owncast internal get-logs`

- Summary: Get all logs
- HTTP: `GET /admin/logs`
- Auth: required
- Body: none
- Flags: none
- Output: columns `level`, `message`, `time`; response media `application/json`

### `owncast internal get-moderators`

- Summary: Get a list of moderator users
- HTTP: `GET /admin/chat/users/moderators`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `authenticated`, `createdAt`, `disabledAt`, `displayColor`, `displayName`; response media `application/json`

### `owncast internal get-pending-follow-requests`

- Summary: Get a list of pending follow requests
- HTTP: `GET /admin/followers/pending`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `disabledAt`, `image`, `link`, `timestamp`, `username`; response media `application/json`

### `owncast internal get-prometheus-api`

- Summary: Endpoint to interface with Prometheus
- HTTP: `GET /admin/prometheus`
- Auth: required
- Body: none
- Flags: none

### `owncast internal get-server-config`

- Summary: Get the current server config
- HTTP: `GET /admin/serverconfig`
- Auth: required
- Body: none
- Flags: none
- Output: list path `externalActions`; columns `color`, `description`, `html`, `icon`, `openExternally`, `title`; response media `application/json`

### `owncast internal get-status`

- Summary: Get the status of the server
- HTTP: `GET /status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal get-users`

- Summary: Get a paginated list of all users
- HTTP: `GET /admin/users`
- Auth: required
- Body: none
- Flags:
  - `--search` (query): Filter to users whose display name contains this substring
  - `--status` (query, one of: all|active|bots): Filter users by status
  - `--sort` (query, default `desc`, one of: asc|desc): Sort direction by creation date (defaults to newest first)
- Output: list path `results`; columns `id`, `authenticated`, `createdAt`, `disabledAt`, `displayColor`, `displayName`; response media `application/json`

### `owncast internal get-video-playback-metrics`

- Summary: Get video playback metrics
- HTTP: `GET /admin/metrics/video`
- Auth: required
- Body: none
- Flags: none
- Output: list path `availableBitrates`; response media `application/json`

### `owncast internal get-video-stream-output-variants`

- Summary: Get a list of video variants available
- HTTP: `GET /video/variants`
- Auth: required
- Body: none
- Flags: none
- Output: columns `name`, `index`; response media `application/json`

### `owncast internal get-viewers-over-time`

- Summary: Get viewer count over time
- HTTP: `GET /admin/viewersOverTime`
- Auth: required
- Body: none
- Flags:
  - `--window-start` (query): Start date in unix time
- Output: columns `time`, `value`; response media `application/json`

### `owncast internal get-warnings`

- Summary: Get warning/error logs
- HTTP: `GET /admin/logs/warnings`
- Auth: required
- Body: none
- Flags: none
- Output: columns `level`, `message`, `time`; response media `application/json`

### `owncast internal get-web-config`

- Summary: Get the web config
- HTTP: `GET /config`
- Auth: required
- Body: none
- Flags: none
- Output: list path `externalActions`; columns `color`, `description`, `html`, `icon`, `openExternally`, `title`; response media `application/json`

### `owncast internal get-webhooks`

- Summary: Get all the webhooks
- HTTP: `GET /admin/webhooks`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `lastUsed`, `timestamp`, `url`; response media `application/json`

### `owncast internal get-yp-response`

- Summary: Get the YP protocol data
- HTTP: `GET /yp`
- Auth: required
- Body: none
- Flags: none
- Output: list path `social`; columns `icon`, `platform`, `url`; response media `application/json`

### `owncast internal handle-indie-auth-endpoint-get`

- Summary: Handles the IndieAuth auth endpoint
- HTTP: `GET /auth/provider/indieauth`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal handle-indie-auth-endpoint-post`

- Summary: Handles IndieAuth from form submission
- HTTP: `POST /auth/provider/indieauth`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal handle-indie-auth-redirect`

- Summary: Handle the redirect from an IndieAuth server to continue the auth flow
- HTTP: `GET /auth/indieauth/callback`
- Auth: required
- Body: none
- Flags: none

### `owncast internal ping`

- Summary: Tell the backend you're an active viewer
- HTTP: `GET /ping`
- Auth: required
- Body: none
- Flags: none

### `owncast internal post-prometheus-api`

- Summary: Endpoint to interface with Prometheus
- HTTP: `POST /admin/prometheus`
- Auth: required
- Body: none
- Flags: none

### `owncast internal put-prometheus-api`

- Summary: Endpoint to interface with Prometheus
- HTTP: `PUT /admin/prometheus`
- Auth: required
- Body: none
- Flags: none

### `owncast internal register-anonymous-chat-user`

- Summary: Registers an anonymous chat user
- HTTP: `POST /chat/register`
- Auth: required
- Body: optional; media type `application/json`
- Flags:
  - `--x-forwarded-user` (header): X-Forwarded-User
- Output: response media `application/json`

### `owncast internal register-fediverse-otp-request`

- Summary: Register a Fediverse OTP request
- HTTP: `POST /auth/fediverse`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal register-for-live-notifications`

- Summary: Register for notifications
- HTTP: `POST /notifications/register`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `owncast internal remote-follow`

- Summary: Request remote follow
- HTTP: `POST /remotefollow`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal remove-federated-server`

- Summary: Remove a federated server
- HTTP: `DELETE /admin/federation/servers/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): ID of the federated server to remove
- Output: response media `application/json`

### `owncast internal remove-follower`

- Summary: Remove a follower without blocking them (they may follow again)
- HTTP: `POST /admin/followers/remove`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal report-cmcd`

- Summary: CMCD collector accepting event and response mode playback reports
- HTTP: `POST /metrics/cmcd`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `owncast internal report-cmcd-query`

- Summary: CMCD collector accepting a report as a query parameter
- HTTP: `GET /metrics/cmcd`
- Auth: required
- Body: none
- Flags:
  - `--cmcd` (query): CMCD report serialized as a CMCD dictionary payload

### `owncast internal report-playback-metrics`

- Summary: Save video playback metrics for future video health recording
- HTTP: `POST /metrics/playback`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none

### `owncast internal reset-favicon`

- Summary: Reset favicon to default
- HTTP: `DELETE /admin/config/favicon`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal reset-yp-registration`

- Summary: Reset YP configuration
- HTTP: `GET /admin/yp/reset`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal send-federated-message`

- Summary: Send a public message to the Fediverse from the server's user
- HTTP: `POST /admin/federation/send`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-admin-password`

- Summary: Change the current admin password
- HTTP: `POST /admin/config/adminpass`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-autoplay`

- Summary: Update autoplay behavior
- HTTP: `POST /admin/config/autoplay`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-browser-notification-configuration`

- Summary: Configure Browser notifications
- HTTP: `POST /admin/config/notifications/browser`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-chat-disabled`

- Summary: Disable chat
- HTTP: `POST /admin/config/chat/disable`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-chat-join-messages-enabled`

- Summary: Enable chat for user join messages
- HTTP: `POST /admin/config/chat/joinmessagesenabled`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-chat-require-authentication`

- Summary: Set require authentication for chat
- HTTP: `POST /admin/config/chat/requireauthentication`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-chat-slur-filter-enabled`

- Summary: Set slur filter enabled
- HTTP: `POST /admin/config/chat/slurfilterenabled`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-chat-spam-protection-enabled`

- Summary: Set spam protection enabled
- HTTP: `POST /admin/config/chat/spamprotectionenabled`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-custom-color-variable-values`

- Summary: Set style/color/css values
- HTTP: `POST /admin/config/appearance`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-custom-javascript`

- Summary: Update custom JavaScript
- HTTP: `POST /admin/config/customjavascript`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-custom-styles`

- Summary: Update custom styles
- HTTP: `POST /admin/config/customstyles`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-directory-enabled`

- Summary: Update directory enabled
- HTTP: `POST /admin/config/directoryenabled`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-disable-search-indexing`

- Summary: Update search indexing
- HTTP: `POST /admin/config/disablesearchindexing`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-discord-notification-configuration`

- Summary: Configure Discord notifications
- HTTP: `POST /admin/config/notifications/discord`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-enable-established-chat-user-mode`

- Summary: Enable/disable chat established user mode
- HTTP: `POST /admin/config/chat/establishedusermode`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-external-actions`

- Summary: Update external action links
- HTTP: `POST /admin/config/externalactions`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-extra-page-content`

- Summary: Change the extra page content in memory
- HTTP: `POST /admin/config/pagecontent`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-favicon`

- Summary: Upload custom favicon
- HTTP: `POST /admin/config/favicon`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-activity-private`

- Summary: Set if federation activities are private
- HTTP: `POST /admin/config/federation/private`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-block-domains`

- Summary: Set Federation blocked domains
- HTTP: `POST /admin/config/federation/blockdomains`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-enable-quotes`

- Summary: Set if posts from this server can be quoted
- HTTP: `POST /admin/config/federation/enablequotes`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-enabled`

- Summary: Enable/disable federation features
- HTTP: `POST /admin/config/federation/enable`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-go-live-message`

- Summary: Set federated go live message
- HTTP: `POST /admin/config/federation/livemessage`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-hide-followers-tab`

- Summary: Set if the public followers tab is hidden on the web UI
- HTTP: `POST /admin/config/federation/hidefollowers`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-show-engagement`

- Summary: Set if fediverse engagement appears in chat
- HTTP: `POST /admin/config/federation/showengagement`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-federation-username`

- Summary: Set local federated username
- HTTP: `POST /admin/config/federation/username`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-ffmpeg-path`

- Summary: Update FFMPEG path
- HTTP: `POST /admin/config/ffmpegpath`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-forbidden-username-list`

- Summary: Set chat usernames that are not allowed
- HTTP: `POST /admin/config/chat/forbiddenusernames`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-hide-viewer-count`

- Summary: Update hide viewer count
- HTTP: `POST /admin/config/hideviewercount`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-logo`

- Summary: Update logo
- HTTP: `POST /admin/config/logo`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-nsfw`

- Summary: Update NSFW marking
- HTTP: `POST /admin/config/nsfw`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-rtmp-server-bind-address`

- Summary: Update RTMP server bind address
- HTTP: `POST /admin/config/rtmpserverbindaddress`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-rtmp-server-port`

- Summary: Update RTMP post
- HTTP: `POST /admin/config/rtmpserverport`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-s3configuration`

- Summary: Update S3 configuration
- HTTP: `POST /admin/config/s3`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-server-url`

- Summary: Update server url
- HTTP: `POST /admin/config/serverurl`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-server-welcome-message`

- Summary: Change the welcome message
- HTTP: `POST /admin/config/welcomemessage`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-social-handles`

- Summary: Update social handles
- HTTP: `POST /admin/config/socialhandles`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-socket-host-override`

- Summary: Update websocket host override
- HTTP: `POST /admin/config/sockethostoverride`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-stream-keys`

- Summary: Set an array of valid stream keys
- HTTP: `POST /admin/config/streamkeys`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-stream-latency-level`

- Summary: Set the number of video segments and duration per segment in a playlist
- HTTP: `POST /admin/config/video/streamlatencylevel`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-stream-output-variants`

- Summary: Set an array of video output configurations
- HTTP: `POST /admin/config/video/streamoutputvariants`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-stream-title`

- Summary: Change the stream title
- HTTP: `POST /admin/config/streamtitle`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-suggested-username-list`

- Summary: Set the suggested chat usernames that will be assigned automatically
- HTTP: `POST /admin/config/chat/suggestedusernames`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal set-tags`

- Summary: Update server tags
- HTTP: `POST /admin/config/tags`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-video-codec`

- Summary: Set video codec
- HTTP: `POST /admin/config/video/codec`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-video-serving-endpoint`

- Summary: Update custom video serving endpoint
- HTTP: `POST /admin/config/videoservingendpoint`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-web-server-ip`

- Summary: Update server IP address
- HTTP: `POST /admin/config/webserverip`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal set-web-server-port`

- Summary: Update server port
- HTTP: `POST /admin/config/webserverport`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast internal start-indie-auth-flow`

- Summary: Begins auth flow
- HTTP: `POST /auth/indieauth`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal status-admin`

- Summary: Get current inboard broadcaster
- HTTP: `GET /admin/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `owncast internal unban-ip-address`

- Summary: Remove an IP ban
- HTTP: `POST /admin/chat/users/ipbans/remove`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal update-message-visibility`

- Summary: Update chat message visibility
- HTTP: `POST /chat/messagevisibility`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal update-message-visibility-admin`

- Summary: Update visibility of chat messages
- HTTP: `POST /admin/chat/messagevisibility`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal update-user-enabled`

- Summary: Enable/disable a user
- HTTP: `POST /chat/users/setenabled`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal update-user-enabled-admin`

- Summary: Enable or disable a user
- HTTP: `POST /admin/chat/users/setenabled`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal update-user-moderator`

- Summary: Set moderator status for a user
- HTTP: `POST /admin/chat/users/setmoderator`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal upload-custom-emoji`

- Summary: Upload custom emoji
- HTTP: `POST /admin/emoji/upload`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

### `owncast internal verify-fediverse-otp-request`

- Summary: Verify Fediverse OTP code
- HTTP: `POST /auth/fediverse/verify`
- Auth: required
- Body: optional; media type `application/json`
- Flags: none
- Output: response media `application/json`

## Objects

### `owncast objects set-custom-offline-message`

- Summary: Change the offline message
- HTTP: `POST /admin/config/offlinemessage`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast objects set-server-name`

- Summary: Change the server name
- HTTP: `POST /admin/config/name`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

### `owncast objects set-server-summary`

- Summary: Change the server summary
- HTTP: `POST /admin/config/serversummary`
- Auth: required
- Body: optional
- Flags: none
- Output: response media `application/json`

Owncast

This recipe generates the owncast CLI and agent Skill for Owncast live-stream administration, webhooks, and integrations.

API and authentication

Owncast admin endpoints use HTTP Basic authentication. Use the admin username and stream key:

owncast auth login --hostname <host> --auth-type basic
owncast auth status --hostname <host>

Install the Skill

owncast skill install --scope user --agent codex --yes

Agent workflow

owncast commands --json
owncast search "list webhooks" --json

Use the returned command path with owncast commands show before execution. Bump the pin in specs/sources.yaml when upgrading the Owncast API.