# Ping

### Endpoint

```
GET /api/v1/ping
```

***

### Example Request

```lua
Auxvyn.ping()
```

***

### Example Response

```json
{
  "success": true,
  "workspaceId": "96b32245-7484-4458-a75a-23f4c0868ca3",
  "workspaceName": "My Game",
  "plan": "free"
}
```

***

### Returns

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

***

### When Is Ping Called

`Auxvyn.ping()` is called automatically inside `Auxvyn.init()` when your game starts up. You will see the result printed in your output:

{% hint style="success" %}
\[Auxvyn] Connected. Workspace: My Game Plan: free
{% endhint %}

You can also call it manually at any time to check connectivity:

```lua
local data = Auxvyn.ping()
if data then
    print("Connected to workspace:", data.workspaceName)
else
    warn("Could not connect to Auxvyn")
end
```

***

### Error Responses

| Code  | Reason                     |
| ----- | -------------------------- |
| `401` | Missing or invalid API key |

***

### 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/api-reference/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.