# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.trickys.gg/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

---

# Documentation

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><i class="fa-gamepad-modern">:gamepad-modern:</i></td><td><strong>Gaming Docs</strong></td><td>Find documentation on some of the games we host to help you out</td><td><a href="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FkapdoFIYVZI2Uh5sTcOb%2FChatGPT%20Image%20Feb%2027%2C%202026%2C%2004_30_21%20AM.png?alt=media&amp;token=b19f51c6-9003-464b-9bb3-7de7d5aedd1c">gaminghome-v1.png</a></td><td></td></tr><tr><td><i class="fa-discord">:discord:</i> </td><td><strong>Discord Docs</strong></td><td>Find some documentation about our discord server</td><td><a href="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FSzslBHtgDHxzIdmgyxTX%2FLVDOKRfM2rH1FdGVaV0AHA.jpeg?alt=media&amp;token=c54871c9-cdf9-4ddd-93a5-cab78211ec6b">dchome-v1.jpeg</a></td><td><a href="/discord">Discord</a></td></tr><tr><td><i class="fa-code">:code:</i> </td><td><strong>API Docs</strong></td><td>Documentation for developers who are looking to use our API</td><td><a href="https://3240897265-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCMf8TjcRclW7vjlT5xle%2Fuploads%2FDzb76JSsjYN8hhzVzW5F%2FChatGPT%20Image%20Feb%2027%2C%202026%2C%2004_10_41%20AM.png?alt=media&amp;token=4f683c90-6c03-441c-9ef9-f011f247e894">apihome-v1.png</a></td><td><a href="https://docs.trickys.gg/developers/">Developers</a></td></tr></tbody></table>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><span data-gb-custom-inline data-tag="emoji" data-code="2b50">⭐</span> <strong>Getting started</strong></td><td><ul><li><a href="/rules">Rules</a></li><li><a href="/custom-profiles">Custom Profiles</a></li><li><a href="/discord/verified">Getting Verified</a></li></ul></td></tr><tr><td><span data-gb-custom-inline data-tag="emoji" data-code="2b06">⬆️</span> <strong>Popular topics</strong></td><td><ul><li><a href="/rules">Rules</a></li><li><a href="/discord/discord-roles">Discord Roles</a></li><li><a href="/games/trucksim">Truck Sim</a></li></ul></td></tr></tbody></table>

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><i class="fa-truck">:truck:</i></td><td><strong>TruckSim</strong></td><td>View our TruckSim docs for ETS2, ATS, VTC and more</td><td><a href="/games/trucksim">Truck Sim</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/227300/9a81dc3126c56637297b654f9dcac057cfd79b77/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/227300/9a81dc3126c56637297b654f9dcac057cfd79b77/header.jpg</a></td></tr><tr><td><i class="fa-rocket">:rocket:</i></td><td><strong>Kerbal Space Program</strong></td><td>View documentation for our KSP server</td><td><a href="/games/kerbal-space-program">Kerbal Space Program</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/220200/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/220200/header.jpg</a></td></tr><tr><td><i class="fa-car">:car:</i></td><td><strong>Motortown</strong></td><td>View documentation for our motortown server</td><td><a href="/games/motortown">MotorTown</a></td><td data-object-fit="fill"><a href="https://shared.fastly.steamstatic.com/store_item_assets/steam/apps/1369670/header.jpg">https://shared.fastly.steamstatic.com/store_item_assets/steam/apps/1369670/header.jpg</a></td></tr><tr><td><i class="fa-tractor">:tractor:</i></td><td><strong>Farming Sim</strong></td><td>View info for our FS server</td><td><a href="/games/farming-sim-25">Farming Sim 25</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/2300320/c2a205133d23cd24faf3c152d972a1d0177661b8/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/2300320/c2a205133d23cd24faf3c152d972a1d0177661b8/header.jpg</a></td></tr><tr><td><i class="fa-car">:car:</i></td><td><strong>BeamMP</strong></td><td>View info for our BMP server</td><td><a href="broken://pages/XQPHtlv9RPzTGOptxXVR">Broken link</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/284160/17f8af1312bc48e6cd90e5fb639d4981682af260/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/284160/17f8af1312bc48e6cd90e5fb639d4981682af260/header.jpg</a></td></tr><tr><td><i class="fa-plane-up">:plane-up:</i></td><td>WarThunder</td><td></td><td><a href="/games/war-thunder">War Thunder</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/236390/65885881b96806d55fea45e130233fdafd78b129/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/236390/65885881b96806d55fea45e130233fdafd78b129/header.jpg</a></td></tr><tr><td><i class="fa-hammer">:hammer:</i></td><td><strong>Ramshackle</strong></td><td></td><td><a href="/games/ramshackle">Ramshackle</a></td><td data-object-fit="fill"><a href="https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/3800200/6af1f16c35a98d4d80de830806b1c2c5deed58dc/header.jpg">https://shared.akamai.steamstatic.com/store_item_assets/steam/apps/3800200/6af1f16c35a98d4d80de830806b1c2c5deed58dc/header.jpg</a></td></tr></tbody></table>


# Authentication

Endpoints for testing and validating API access

## Request Ping

> Test endpoint to verify access to the API.

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"tags":[{"name":"Authentication","description":"Endpoints for testing and validating API access"}],"servers":[{"url":"https://trickys.gg"}],"security":[{"ApiKeyQuery":[]},{"ApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apikey"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}},"paths":{"/api/v1/ping":{"get":{"tags":["Authentication"],"summary":"Request Ping","description":"Test endpoint to verify access to the API.","responses":{"200":{"description":"Successful ping","content":{"application/json":{}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


# Server Status

Query live status for a specific Stormworks server

## Stormworks server status

> Returns live status information for a specified Stormworks server.

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"tags":[{"name":"Server Status","description":"Query live status for a specific Stormworks server"}],"servers":[{"url":"https://trickys.gg"}],"security":[{"ApiKeyQuery":[]},{"ApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apikey"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}},"paths":{"/api/v1/swserverstatus":{"get":{"tags":["Server Status"],"summary":"Stormworks server status","description":"Returns live status information for a specified Stormworks server.","parameters":[{"in":"query","name":"server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful status lookup (Online or Offline)","content":{"application/json":{}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown server identifier","content":{"application/json":{}}}}}}}}
```


# Server Uptime

Reset the tracked uptime for a server

## Reset server uptime

> Resets the tracked uptime for a specified Stormworks server.

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"tags":[{"name":"Server Uptime","description":"Reset the tracked uptime for a server"}],"servers":[{"url":"https://trickys.gg"}],"security":[{"ApiKeyQuery":[]},{"ApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apikey"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}},"paths":{"/api/v1/swserverstatus/resetuptime":{"post":{"tags":["Server Uptime"],"summary":"Reset server uptime","description":"Resets the tracked uptime for a specified Stormworks server.","parameters":[{"in":"query","name":"server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Uptime reset successfully","content":{"application/json":{}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown server identifier","content":{"application/json":{}}}}}}}}
```


# Server Ping

Ping test to server locations (RTT metrics)

## Ping test to server locations

> Performs ping tests to available Stormworks server locations and returns RTT metrics.

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"tags":[{"name":"Server Ping","description":"Ping test to server locations (RTT metrics)"}],"servers":[{"url":"https://trickys.gg"}],"security":[{"ApiKeyQuery":[]},{"ApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apikey"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}},"paths":{"/api/v1/swserverstatus/ping":{"get":{"tags":["Server Ping"],"summary":"Ping test to server locations","description":"Performs ping tests to available Stormworks server locations and returns RTT metrics.","parameters":[{"in":"query","name":"server","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ping results","content":{"application/json":{}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Unknown server identifier","content":{"application/json":{}}}}}}}}
```


# Global Info

General Stormworks information

## Global player count

> Returns the total global Stormworks player count.

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"tags":[{"name":"Global Info","description":"General Stormworks information"}],"servers":[{"url":"https://trickys.gg"}],"security":[{"ApiKeyQuery":[]},{"ApiKeyHeader":[]}],"components":{"securitySchemes":{"ApiKeyQuery":{"type":"apiKey","in":"query","name":"apikey"},"ApiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-KEY"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}},"paths":{"/api/v1/swinfo":{"get":{"tags":["Global Info"],"summary":"Global player count","description":"Returns the total global Stormworks player count.","responses":{"200":{"description":"Global player count","content":{"application/json":{}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


# Models

## The Uptime object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"Uptime":{"type":"object","properties":{"uptimeShort":{"type":"string"},"uptimeLong":{"type":"string"},"uptimeSeconds":{"type":"integer"}}}}}}
```

## The SWServerStatusSuccess object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"SWServerStatusSuccess":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"responseTimeMs":{"type":"integer"},"uptime":{"$ref":"#/components/schemas/Uptime"},"serverName":{"type":"string"},"onlinePlayers":{"type":"integer"},"maxPlayers":{"type":"integer"},"operatingSystem":{"type":"string"},"hasPassword":{"type":"string"},"serverId":{"type":"integer"},"version":{"type":"string"},"serverTPS":{"type":"string"},"isUpToDate":{"type":"boolean"},"isWeaponsDlc":{"type":"boolean"},"isIndustrialDlc":{"type":"boolean"},"isSpaceDlc":{"type":"boolean"},"owner":{"type":"string"},"serverLocation":{"type":"string"},"GblsAccess":{"type":"boolean"},"GblsApi":{"type":"boolean"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}},"Uptime":{"type":"object","properties":{"uptimeShort":{"type":"string"},"uptimeLong":{"type":"string"},"uptimeSeconds":{"type":"integer"}}}}}}
```

## The SWServerStatusOffline object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"SWServerStatusOffline":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}}}
```

## The ResetUptimeResponse object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"ResetUptimeResponse":{"type":"object","properties":{"success":{"type":"boolean"},"status":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The PingResponse object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"PingResponse":{"type":"object","properties":{"success":{"type":"boolean"},"updated":{"type":"integer"},"data":{"type":"object","additionalProperties":{"type":"object","properties":{"Info":{"type":"object","properties":{"countryCode":{"type":"string"},"countryName":{"type":"string"},"cityName":{"type":"string"}}},"pingResults":{"type":"object","properties":{"success":{"type":"boolean"},"requestsSent":{"type":"integer"},"requestsReceived":{"type":"integer"},"rttMinMs":{"type":"number","format":"float"},"rttAvgMs":{"type":"number","format":"float"},"rttMaxMs":{"type":"number","format":"float"}}}}}},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}}}
```

## The GlobalInfoResponse object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"GlobalInfoResponse":{"type":"object","properties":{"success":{"type":"boolean"},"globalPlayerCount":{"type":"integer"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Tricky's API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"TrickysAPIinfo":{"type":"object","properties":{"APIversion":{"type":"string"}}}}}}}}
```