CrossWatch

https://wiki.crosswatch.app/
Admin
CrossWatch is a tool that synchronizes watchlist, history, ratings, and progress data across...
Tokens:111,124
Snippets:1,896
Trust Score:2.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Dynamic Documentation Query Example

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/chunking

Demonstrates how to query documentation dynamically using an HTTP GET request with an 'ask' query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/orchestrator/chunking.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://wiki.crosswatch.app/crosswatch/navigation/ui-settings/security

Use this GET request to ask questions about the documentation dynamically. Replace `<question>` with your specific query.

```http
GET https://wiki.crosswatch.app/crosswatch/navigation/ui-settings/security.md?ask=<question>
```

--------------------------------

### Querying Documentation via GET Request

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_emby

This example demonstrates how to dynamically query the documentation for additional information. By making an HTTP GET request to the page URL with an 'ask' query parameter, you can retrieve specific answers and relevant excerpts.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_emby.md?ask=<question>
```

--------------------------------

### Provider API Request Example

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/provider-contract

Example of how to query documentation dynamically using the `ask` query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/orchestrator/provider-contract.md?ask=<question>
```

--------------------------------

### Querying CrossWatch Documentation

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_crosswatch

This example demonstrates how to query the CrossWatch documentation dynamically using an HTTP GET request with an 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_crosswatch.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_simkl

Demonstrates how to dynamically query the documentation for additional information by making an HTTP GET request with an 'ask' query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_simkl.md?ask=<question>
```

--------------------------------

### Chunking Configuration Example

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/chunking

Example of runtime configuration for chunking, including base chunk size, pause between chunks, and provider-specific overrides.

```json
{
  "runtime": {
    "apply_chunk_size": 50,
    "apply_chunk_pause_ms": 200,
    "apply_chunk_size_by_provider": {
      "TRAKT": 10,
      "SIMKL": 25
    }
  }
}
```

--------------------------------

### Install CrossWatch on Proxmox LXC

Source: https://wiki.crosswatch.app/related-information/community/install-scripts/proxmox-lxc-installer

Run this command on your Proxmox host to initiate the CrossWatch installation within an LXC container. It downloads and executes the installation script.

```bash
bash -c "$(wget -qLO - https://raw.githubusercontent.com/doctorjz/ProxmoxVE/main/ct/crosswatch.sh)"
```

--------------------------------

### Querying Tautulli Adapter Documentation

Source: https://wiki.crosswatch.app/crosswatch/providers/synchronization/adapter-tautulli

To get specific information not directly visible on the page, you can query the documentation dynamically using the `ask` query parameter in an HTTP GET request.

```http
GET https://wiki.crosswatch.app/crosswatch/providers/synchronization/adapter-tautulli.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_emby/overview

Demonstrates how to query the documentation dynamically by making an HTTP GET request to the page URL with an 'ask' query parameter. This is useful for retrieving specific information or clarification not explicitly present on the page.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_emby/overview.md?ask=<question>
```

--------------------------------

### Snapshot Index Normalization Example

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/snapshots

This example illustrates how provider output, whether a list or a dictionary, is normalized into a `SnapIndex` format. The canonical key is determined by a priority list of external IDs.

```python
{
    canonical_key: { ...item fields... }
}
```

--------------------------------

### Query Documentation API

Source: https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_tmdb

Demonstrates how to query this documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_tmdb.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/crosswatch/providers/authentication/auth-others

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. The question should be specific and self-contained. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```http
GET https://wiki.crosswatch.app/crosswatch/providers/authentication/auth-others.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_tautulli/watchlist

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_tautulli/watchlist.md?ask=<question>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://wiki.crosswatch.app/crosswatch/navigation/ui-settings

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language. Use this when the answer is not explicitly present, for clarification, or to retrieve related documentation.

```http
GET https://wiki.crosswatch.app/crosswatch/navigation/ui-settings.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/caching-layers

Perform an HTTP GET request on the current page URL with the 'ask' query parameter to dynamically query the documentation. The question should be specific and in natural language.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/orchestrator/caching-layers.md?ask=<question>
```

--------------------------------

### Query Crosswatch Documentation Dynamically

Source: https://wiki.crosswatch.app/crosswatch/tools/analyzer

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to get specific answers and relevant excerpts from the documentation. Use this when information is not explicitly present or clarification is needed.

```http
GET https://wiki.crosswatch.app/crosswatch/tools/analyzer.md?ask=<question>
```

--------------------------------

### Agent Instructions: Querying Documentation

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_jellyfin

Instructions on how to dynamically query the documentation using an HTTP GET request with the 'ask' query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_jellyfin.md?ask=<question>
```

--------------------------------

### Agent Instructions for Querying Documentation

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/two-way-sync

Instructions on how to query the documentation dynamically using an HTTP GET request with the 'ask' query parameter.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/orchestrator/two-way-sync.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_tautulli/overview

To get additional information not directly on the page, perform an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_tautulli/overview.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_mdblist

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_mdblist.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://wiki.crosswatch.app/related-information/community

Use this GET request to ask questions about the documentation. The response includes direct answers and relevant excerpts.

```http
GET https://wiki.crosswatch.app/related-information/community.md?ask=<question>
```

--------------------------------

### Query Documentation via GET Request

Source: https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_emby

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_emby.md?ask=<question>
```

--------------------------------

### Example Runtime Configuration

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/runtime

This JSON snippet demonstrates how to configure runtime settings, including chunk size and provider-specific chunk sizes. It overrides the base chunk size for specific providers like SIMKL and TRAKT.

```json
{
  "runtime": {
    "apply_chunk_size": 50,
    "apply_chunk_size_by_provider": {
      "SIMKL": 25,
      "TRAKT": 10
    }
  }
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_tautulli

To get additional information not directly present on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_tautulli.md?ask=<question>
```

--------------------------------

### UI HTTPS/TLS Configuration Example

Source: https://wiki.crosswatch.app/crosswatch/navigation/ui-settings/user-interface/https-tls

This JSON snippet shows the configuration for enabling HTTPS and setting TLS options for the UI. It includes options for self-signed certificates or custom certificate files.

```json
"ui": {
  "protocol": "https",
  "tls": {
    "self_signed": true,
    "hostname": "localhost",
    "valid_days": 825,
    "cert_file": "",
    "key_file": ""
  }
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/related-information

To get additional information not directly on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language. Use this for clarifications or to retrieve related documentation.

```http
GET https://wiki.crosswatch.app/related-information.md?ask=<question>
```

--------------------------------

### Query Documentation via GET Request

Source: https://wiki.crosswatch.app/crosswatch/configure-pairs/provider-settings

To get information not explicitly present on the page, make a GET request to the current page URL with an 'ask' query parameter. This is useful for clarifications, additional context, or retrieving related documentation sections.

```http
GET https://wiki.crosswatch.app/crosswatch/configure-pairs/provider-settings.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_anilist

Demonstrates how to query this documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information or clarification not explicitly present on the page.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_anilist.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://wiki.crosswatch.app/related-information/release-notes/version-0.0/v0.0.6

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language. Use this for clarifications or retrieving related documentation.

```http
GET https://wiki.crosswatch.app/related-information/release-notes/version-0.0/v0.0.3.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_trakt/overview

To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language. The response will include a direct answer and relevant excerpts.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_trakt/overview.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://wiki.crosswatch.app/related-information/community/install-scripts/synology-with-portainer-or-dockhand

To get specific information not explicitly found on the page, you can use this HTTP GET request format. Append your question as the `ask` query parameter to the page URL. The response will include a direct answer and relevant excerpts.

```http
GET https://wiki.crosswatch.app/related-information/community/install-scripts/synology-with-portainer-or-dockhand.md?ask=<question>
```

--------------------------------

### Plex Module Configuration Reference

Source: https://wiki.crosswatch.app/blueprint-architecture/sync/_mod_plex

Details the configuration options and dependencies for the Plex module.

```text
Config namespace:

* cfg["plex"] (fallback: cfg["auth"]["plex"])

Fields:

* token, baseurl, client_id
* server_name, machine_id
* username, account_id, home_pin, password
* timeout (default: 10.0)
* max_retries (default: 3)
* watchlist_allow_pms_fallback (default: true)
* watchlist_page_size (default: 100)

Dependencies:

* requires: ['plexapi']
```

--------------------------------

### Metrics Schema Example

Source: https://wiki.crosswatch.app/blueprint-architecture/orchestrator/state-json

An example of the optional 'metrics' schema, detailing API usage statistics, last update timestamp, and provider-specific metrics.

```json
"metrics": {
  "api": {
    "last": {
      "ts": 1738100000,
      "total": 1234,
      "providers": {
        "SIMKL": {
          "total": 300,
          "by_endpoint": { ... },
          "by_feature": { ... },
          "by_method": { ... },
          "by_status": { ... },
          "latency_ms_avg": 123,
          "latency_ms_samples": 300
        }
      }
    }
  }
}
```

--------------------------------

### Sync Run Summary Example

Source: https://wiki.crosswatch.app/getting-started/first-time-setup/what-do-you-need/syncing/sync-results

A typical summary output after a sync run completes, showing total counts for different types of operations.

```text
[i] Done. Total added: 0, Total removed: 0, Total skipped: 173, Total unresolved: 0, Total errors: 0, Total blocked: 0
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://wiki.crosswatch.app/related-information/release-notes/version-0.9/v0.9.16

To get additional information not directly present on a page, perform an HTTP GET request on the page URL with the `ask` query parameter. The question should be specific and in natural language. This mechanism is useful for clarifications, additional context, or retrieving related documentation sections.

```http
GET https://wiki.crosswatch.app/related-information/release-notes/version-0.9/v0.9.9.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_anilist

Demonstrates how to query this documentation dynamically using an HTTP GET request with the 'ask' query parameter. This is useful for retrieving specific information not explicitly present on the page.

```http
GET https://wiki.crosswatch.app/blueprint-architecture/auth/_auth_anilist.md?ask=<question>
```

--------------------------------

### Querying Documentation via API

Source: https://wiki.crosswatch.app/crosswatch/providers/synchronization/adapter-crosswatch

Demonstrates how to query the documentation dynamically by making an HTTP GET request to the page URL with an 'ask' query parameter containing the question.

```http
GET https://wiki.crosswatch.app/crosswatch/providers/synchronization/adapter-crosswatch.md?ask=<question>
```
Tokens:
Raw