home / skills / jeremylongshore / claude-code-plugins-plus-skills / vastai-hello-world

This skill helps you bootstrap a minimal Vast.ai integration and verify API connectivity with an executable hello world example.

npx playbooks add skill jeremylongshore/claude-code-plugins-plus-skills --skill vastai-hello-world

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
2.2 KB
---
name: vastai-hello-world
description: |
  Create a minimal working Vast.ai example.
  Use when starting a new Vast.ai integration, testing your setup,
  or learning basic Vast.ai API patterns.
  Trigger with phrases like "vastai hello world", "vastai example",
  "vastai quick start", "simple vastai code".
allowed-tools: Read, Write, Edit
version: 1.0.0
license: MIT
author: Jeremy Longshore <[email protected]>
---

# Vast.ai Hello World

## Overview
Minimal working example demonstrating core Vast.ai functionality.

## Prerequisites
- Completed `vastai-install-auth` setup
- Valid API credentials configured
- Development environment ready

## Instructions

### Step 1: Create Entry File
Create a new file for your hello world example.

### Step 2: Import and Initialize Client
```typescript
import { Vast.aiClient } from '@vastai/sdk';

const client = new Vast.aiClient({
  apiKey: process.env.VASTAI_API_KEY,
});
```

### Step 3: Make Your First API Call
```typescript
async function main() {
  // Your first API call here
}

main().catch(console.error);
```

## Output
- Working code file with Vast.ai client initialization
- Successful API response confirming connection
- Console output showing:
```
Success! Your Vast.ai connection is working.
```

## Error Handling
| Error | Cause | Solution |
|-------|-------|----------|
| Import Error | SDK not installed | Verify with `npm list` or `pip show` |
| Auth Error | Invalid credentials | Check environment variable is set |
| Timeout | Network issues | Increase timeout or check connectivity |
| Rate Limit | Too many requests | Wait and retry with exponential backoff |

## Examples

### TypeScript Example
```typescript
import { Vast.aiClient } from '@vastai/sdk';

const client = new Vast.aiClient({
  apiKey: process.env.VASTAI_API_KEY,
});

async function main() {
  // Your first API call here
}

main().catch(console.error);
```

### Python Example
```python
from vastai import Vast.aiClient

client = Vast.aiClient()

# Your first API call here
```

## Resources
- [Vast.ai Getting Started](https://docs.vastai.com/getting-started)
- [Vast.ai API Reference](https://docs.vastai.com/api)
- [Vast.ai Examples](https://docs.vastai.com/examples)

## Next Steps
Proceed to `vastai-local-dev-loop` for development workflow setup.

Overview

This skill provides a minimal working Vast.ai example to verify your integration and learn core API patterns. It includes a compact client initialization and a first API call template in both Python and TypeScript. Use it to confirm authentication, network connectivity, and basic request flow. The example returns a simple success message when the connection is working.

How this skill works

The skill shows how to import the Vast.ai client, initialize it with API credentials, and run a single test API call to validate the setup. It demonstrates where to place your API key and how to capture a successful response or basic errors. Error cases and remedies are highlighted so you can quickly resolve common integration problems. The example is intentionally small to be copy-paste runnable in a dev environment.

When to use it

  • Starting a new Vast.ai integration and needing a minimal reference
  • Testing that your API credentials and network access are configured correctly
  • Learning the basic request/response pattern of the Vast.ai SDK
  • Debugging import, auth, timeout, or rate-limit issues quickly
  • Verifying a CI/CD agent or local environment can reach the Vast.ai API

Best practices

  • Store API keys in environment variables and avoid hard-coding secrets
  • Wrap the demo call in a try/catch (or try/except) and surface clear error messages
  • Implement retries with exponential backoff for transient network or rate-limit errors
  • Start with the minimal example, then expand to secure config and logging
  • Run the example in the same environment your production code will use to catch env differences

Example use cases

  • Quickly confirming VASTAI_API_KEY is valid and the client can authenticate
  • Smoke-testing a new machine image or container that needs API access
  • Teaching new team members Vast.ai basics with a runnable hello-world script
  • Creating a reproducible reproduction for support when filing an integration bug
  • Bootstrapping a larger automation flow after verifying the client connection

FAQ

What if the import fails?

Ensure the SDK is installed for your language and the environment path matches where you installed it; re-run package install commands and verify with package manager listings.

How do I fix authentication errors?

Confirm your API key is set in the environment variable the example expects and that there are no extra characters or newlines; regenerate credentials if needed.

What should I do on timeouts or rate limits?

Increase request timeouts, check network connectivity, and implement exponential backoff and retry logic for rate-limited responses.