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

# Slug Available

GET https://api.onepin.ai/api/v1/workspaces/slug-available

Check whether a slug is available for the current workspace. Admin only.

Returns `{ available: true }` if the slug is valid, not reserved, and
not already claimed by another workspace. When unavailable, `reason`
indicates why: `invalid` (format/length), `reserved` (blocked word), or
`taken` (already in use globally). The workspace's own current slug is
self-excluded, so an admin can safely check their existing slug without
receiving `taken`.

This is an advisory point-in-time check — a concurrent `POST /workspaces`
or `PATCH /workspaces/{id}` from another session can claim the slug
between this response and the caller's write. Always handle 409
`WORKSPACE_SLUG_TAKEN` on `create_workspace` and `update_workspace`.

Requires the `X-Workspace-Id` header (the workspace being renamed) and
admin role in that workspace. Missing/invalid header returns 400; not a
member returns 404; not admin returns 403.

Reference: https://onepin.ai/docs/reference/api-reference/workspaces/slug-available-api-v-1-workspaces-slug-available-get

## Authentication

- `Authorization` header (bearer token, required) — Clerk JWT token

## Servers

- `https://api.onepin.ai` (prod, default)
- `https://dev-api.onepin.ai` (dev)

## Request

### Query parameters

- `slug` (string, required) — Candidate slug; normalized (strip().lower()) before checks.

### Headers

- `X-Workspace-Id` (string, optional, nullable)

## Response

### 200

Successful Response

- `data` (SlugAvailabilityOut, required) — POD-557: result of GET /workspaces/slug-available. `reason` is set only when `available` is False (first failure in order format → reserved → taken).
- `meta` (Meta, required)

## Errors

### 400 Bad Request Error

Missing or invalid X-Workspace-Id header

- `error` (ApiErrorBody, required)
- `meta` (Meta, required)

### 403 Forbidden Error

Caller is not an admin of the workspace

- `error` (ApiErrorBody, required)
- `meta` (Meta, required)

### 404 Not Found Error

Workspace not found / caller is not a member

- `error` (ApiErrorBody, required)
- `meta` (Meta, required)

### 422 Unprocessable Entity Error

Missing ?slug query parameter

- `error` (ApiErrorBody, required)
- `meta` (Meta, required)

## Types

### SlugAvailabilityOut

POD-557: result of GET /workspaces/slug-available. `reason` is set only when `available` is False (first failure in order format → reserved → taken).

- `available` (boolean, required)
- `reason` (enum, optional, nullable)
  - Allowed values: `invalid`, `reserved`, `taken`

### Meta

- `request_id` (string, required)
- `timestamp` (datetime, required)

### ApiErrorBody

- `code` (string, required)
- `message` (string, required)
- `details` (list of ApiErrorDetail, optional, default: [])

### ApiErrorDetail

- `field` (string, required)
- `message` (string, required)
- `line_numbers` (list of integer, optional, nullable)
- `min_chars` (integer, optional, nullable)

## Examples

**Response**

```json
{
  "data": {
    "available": true,
    "reason": "invalid"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.onepin.ai/api/v1/workspaces/slug-available"

querystring = {"slug":"slug"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.onepin.ai/api/v1/workspaces/slug-available?slug=slug';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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.onepin.ai/api/v1/workspaces/slug-available?slug=slug"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.onepin.ai/api/v1/workspaces/slug-available?slug=slug")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.onepin.ai/api/v1/workspaces/slug-available?slug=slug")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.onepin.ai/api/v1/workspaces/slug-available?slug=slug', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.onepin.ai/api/v1/workspaces/slug-available?slug=slug");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.onepin.ai/api/v1/workspaces/slug-available?slug=slug")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```