> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.loreos.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.loreos.app/_mcp/server.

# Demo Sandbox Availability

GET https://api.loreos.app/v1/demo/sandbox-key/availability

Report whether anonymous demo-key issuance is usable before a caller mutates state.

Reference: https://docs.loreos.app/api-reference/sandbox-and-reference/demo-sandbox-availability

## Servers

- `https://api.loreos.app` (Production, default)
- `http://127.0.0.1:8000` (Local development)

## Response

### 200

Successful Response

- `schema_version` ("v0", required) — LoreOS success-envelope version.
- `data` (DemoSandboxAvailabilityData, required)
- `next_actions` (list of V1NextAction, required) — Concrete follow-up API actions; empty when no action is required.

## Types

### DemoSandboxAvailabilityData

- `status` (enum, required)
  - Allowed values: `available`, `challenge_required`, `disabled`, `misconfigured`
- `issuance_available` (boolean, required) — Whether a caller can currently obtain a key, subject to rate limits.
- `challenge_required` (boolean, required)
- `issuance_operation` ("POST /v1/demo/sandbox-key", required)
- `persistent_key_docs` (string, required)
- `retryable` (boolean, required)
- `limits` (DemoSandboxLimits, required)
- `note` (string, required)

### V1NextAction

- `command` (string, required) — The next API command an agent can execute.
- `description` (string, required) — Why or when to execute the command.

### DemoSandboxLimits

- `ttl_seconds` (integer, required)
- `credit_limit` (double, required)
- `characters` (integer, required)
- `sessions` (integer, required)
- `messages` (integer, required)
- `max_input_chars` (integer, required)
- `image_generation` (boolean, required)
- `telegram` (boolean, required)
- `webhooks` (boolean, required)

## Examples

**Response**

```json
{
  "schema_version": "string",
  "data": {
    "status": "available",
    "issuance_available": true,
    "challenge_required": true,
    "issuance_operation": "string",
    "persistent_key_docs": "string",
    "retryable": true,
    "limits": {
      "ttl_seconds": 1,
      "credit_limit": 1.1,
      "characters": 1,
      "sessions": 1,
      "messages": 1,
      "max_input_chars": 1,
      "image_generation": true,
      "telegram": true,
      "webhooks": true
    },
    "note": "string"
  },
  "next_actions": [
    {
      "command": "string",
      "description": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.loreos.app/v1/demo/sandbox-key/availability"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.loreos.app/v1/demo/sandbox-key/availability';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.loreos.app/v1/demo/sandbox-key/availability"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.loreos.app/v1/demo/sandbox-key/availability")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.loreos.app/v1/demo/sandbox-key/availability")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.loreos.app/v1/demo/sandbox-key/availability');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.loreos.app/v1/demo/sandbox-key/availability");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.loreos.app/v1/demo/sandbox-key/availability")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```