# Public Docs

Source: https://opvs.ai/docs/api/public-docs

## `GET` /api/v1/public/docs/resolve-domain

**Resolve Domain**

Resolve a custom domain to a brand slug. Used by the CF Worker middleware.

**Parameters**

- `domain` (query, string, required)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/resolve-domain' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/resolve-domain",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/resolve-domain", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/resolve-domain", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/public/docs/projects

**List Public Projects**

List all public documentation projects across all brands.

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/projects' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/projects",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/projects", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/projects", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response

## `GET` /api/v1/public/docs/{brand_slug}

**Get Public Project**

Get public docs project for a brand, including theme settings.

**Parameters**

- `brand_slug` (path, string, required)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/{brand_slug}' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/{brand_slug}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/{brand_slug}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/{brand_slug}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/public/docs/{brand_slug}/tree

**Get Public Doc Tree**

Get sidebar navigation tree for a brand's public docs.

**Parameters**

- `brand_slug` (path, string, required)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/{brand_slug}/tree' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/tree",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/{brand_slug}/tree", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/tree", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/public/docs/{brand_slug}/search

**Search Public Docs**

Full-text search within a brand's public docs.

**Parameters**

- `brand_slug` (path, string, required)
- `q` (query, string, required)
- `limit` (query, integer, optional)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/{brand_slug}/search' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/search",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/{brand_slug}/search", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/search", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## `GET` /api/v1/public/docs/{brand_slug}/{page_path}

**Get Public Doc Page**

Get a single public doc page with rendered HTML and TOC.

**Parameters**

- `brand_slug` (path, string, required)
- `page_path` (path, string, required)

```bash
curl -X GET 'https://app.opvs.ai/api/v1/public/docs/{brand_slug}/{page_path}' \
  -H 'Authorization: Bearer <token>'
```

```python
import httpx

resp = httpx.get(
    "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/{page_path}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
```

```javascript
const resp = await fetch("https://app.opvs.ai/api/v1/public/docs/{brand_slug}/{page_path}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
```

```go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/public/docs/{brand_slug}/{page_path}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}
```

**Responses**

- `200` — Successful Response
- `422` — Validation Error

## Resolve Domain

`GET https://app.opvs.ai/api/v1/public/docs/resolve-domain`

Resolve a custom domain to a brand slug. Used by the CF Worker middleware.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## List Public Projects

`GET https://app.opvs.ai/api/v1/public/docs/projects`

List all public documentation projects across all brands.

## Get Public Project

`GET https://app.opvs.ai/api/v1/public/docs/{brand_slug}`

Get public docs project for a brand, including theme settings.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Get Public Doc Tree

`GET https://app.opvs.ai/api/v1/public/docs/{brand_slug}/tree`

Get sidebar navigation tree for a brand's public docs.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Search Public Docs

`GET https://app.opvs.ai/api/v1/public/docs/{brand_slug}/search`

Full-text search within a brand's public docs.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |

## Get Public Doc Page

`GET https://app.opvs.ai/api/v1/public/docs/{brand_slug}/{page_path}`

Get a single public doc page with rendered HTML and TOC.

| Code | When | What to do |
| --- | --- | --- |
| 422 | Validation Error |  |