velyana 0.1.1

Internal SDK for Velyana Red Teaming API

Usage Documentation

1. Initialization

from velyana import VelyanaRedTeamClient

# Uses VELYANA_API_KEY environment variable and defaults to api_version="v1"
client = VelyanaRedTeamClient()

# Or pass explicitly
client = VelyanaRedTeamClient(api_key="your_api_key", api_version="v2")

2. Triggering a test with JSON body

The SDK encapsulates all endpoint paths. You only need to pass the body. Using a dictionary will automatically send the request as JSON:

payload = {
    "input": "test prompt",
    "attack_type": "jailbreak"
}

response = client.run_test(body=payload)
print(response.status_code)

3. Triggering with a raw body

To send non-JSON bodies (like raw text attacks):

response = client.run_test(body="raw string body")
print(response.status_code)

4. Triggering a specific attack

payload = {"target_model": "llama3", "prompt": "ignore previous instructions"}
response = client.trigger_attack("prompt-injection", body=payload)

5. Custom headers

You can override or append headers to specific requests:

client.run_test(body={}, headers={"X-Test": "true", "Content-Type": "text/xml"})

6. Error handling

from velyana.exceptions import APIError

try:
    response = client.run_test(body={})
except APIError as e:
    print(f"Error ({e.status_code}): {e.response_body}")
except Exception as e:
    print(e)

7. Async Usage

Use the corresponding a prefixed methods for asyncio:

import asyncio
from velyana import VelyanaRedTeamClient

async def main():
    client = VelyanaRedTeamClient()
    response = await client.arun_test(body={"attack": "eval()"})
    print(response.status_code)

asyncio.run(main())