# Auxvyn.ping()

### Syntax

```lua
Auxvyn.ping(): any
```

***

### Returns

A table containing workspace info if successful, or `nil` if the connection failed.

| Field           | Type   | Description                         |
| --------------- | ------ | ----------------------------------- |
| `workspaceId`   | string | The ID of the connected workspace   |
| `workspaceName` | string | The name of the connected workspace |
| `plan`          | string | The current plan — `free` or `pro`  |

***

### Example

```lua
local data = Auxvyn.ping()

if data then
    print("Connected to:", data.workspaceName)
    print("Plan:", data.plan)
else
    warn("Connection failed")
end
```

***

### Notes

* `ping()` is called automatically inside `Auxvyn.init()` you do not need to call it manually on startup
* Use it if you want to check connectivity at a specific point in your game, for example before a critical save operation

***

### What's Next


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://auxvyn.gitbook.io/auxvyn-docs/module/auxvyn.ping.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.