AgentDocs

Api List Projects

GET/api/v1/docs/projects

List documentation projects for the current brand.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Project

POST/api/v1/docs/projects

Create a new documentation project.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Get Project

GET/api/v1/docs/projects/{project_id}

Get a documentation project with page count.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Update Project

PATCH/api/v1/docs/projects/{project_id}

Update a documentation project. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/projects/{project_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/projects/{project_id}", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Delete Project

DELETE/api/v1/docs/projects/{project_id}

Soft-delete a documentation project. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/projects/{project_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/projects/{project_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Pages

GET/api/v1/docs/projects/{project_id}/pages

List pages in a project. Use view=tree for nested structure.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Page

POST/api/v1/docs/projects/{project_id}/pages

Create a new page with initial content (first revision).

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Get Page

GET/api/v1/docs/projects/{project_id}/pages/{slug}

Get a page with its current content.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Update Page

PUT/api/v1/docs/projects/{project_id}/pages/{slug}

Update a page (creates a new revision). Deduplicates identical content.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PUT "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PUT",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PUT", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Delete Page

DELETE/api/v1/docs/projects/{project_id}/pages/{slug}

Soft-delete a page.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Move Page

PATCH/api/v1/docs/projects/{project_id}/pages/{slug}/move

Move a page to a new path or change sort order. Does not create a revision.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/move" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/move",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/move", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/move", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Get Revision History

GET/api/v1/docs/pages/{page_id}/history

Get revision history for a page.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/pages/{page_id}/history" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/pages/{page_id}/history",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/pages/{page_id}/history", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/pages/{page_id}/history", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Get Revision

GET/api/v1/docs/revisions/{revision_id}

Get a specific revision with full content.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/revisions/{revision_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/revisions/{revision_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/revisions/{revision_id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/revisions/{revision_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Compute Diff

GET/api/v1/docs/pages/{page_id}/diff

Compute unified diff between two revisions. Omit 'from' for parent comparison.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/pages/{page_id}/diff" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/pages/{page_id}/diff",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/pages/{page_id}/diff", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/pages/{page_id}/diff", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Rollback

POST/api/v1/docs/pages/{page_id}/rollback

Rollback a page to a previous revision. Creates a new (non-destructive) revision.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/pages/{page_id}/rollback" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/pages/{page_id}/rollback",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/pages/{page_id}/rollback", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/pages/{page_id}/rollback", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Media

GET/api/v1/docs/projects/{project_id}/media

List media files in a project.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/media", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Upload Media

POST/api/v1/docs/projects/{project_id}/media

Upload a media file (image, PDF, etc.) to R2 storage.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/media", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/media", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Recent Pages

GET/api/v1/docs/recent-pages

List the most recently updated pages across every project in the brand.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/recent-pages" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/recent-pages",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/recent-pages", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/recent-pages", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Search

GET/api/v1/docs/search

Full-text search across all pages in the brand's documentation.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/search" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/search",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/search", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/search", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Branches

GET/api/v1/docs/projects/{project_id}/branches

List branches for a project.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Branch

POST/api/v1/docs/projects/{project_id}/branches

Create a new branch for draft/review workflows.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Branch Diff

GET/api/v1/docs/projects/{project_id}/branches/{branch_name}/diff

Get diff summary for a branch compared to main.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/diff" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/diff",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/diff", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/diff", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Merge Branch

POST/api/v1/docs/projects/{project_id}/branches/{branch_name}/merge

Merge a branch into main. Creates new revisions for affected pages.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/merge" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/merge",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/merge", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}/merge", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Close Branch

DELETE/api/v1/docs/projects/{project_id}/branches/{branch_name}

Close a branch without merging.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/branches/{branch_name}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Bulk Create Pages

POST/api/v1/docs/projects/{project_id}/pages/bulk

Bulk create/update pages. Used by agents for multi-page writes.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/bulk" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/bulk",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/bulk", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/bulk", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Tokens

GET/api/v1/docs/tokens

List all access tokens for the brand. Brand admin only.

Request

curl "https://app.opvs.ai/api/v1/docs/tokens" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/tokens",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/tokens", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/tokens", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Token

POST/api/v1/docs/tokens

Create a new access token. Returns the full token once (never again). Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/tokens" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/tokens",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/tokens", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/tokens", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Update Token

PATCH/api/v1/docs/tokens/{token_id}

Update token permissions or status. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/tokens/{token_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/tokens/{token_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/tokens/{token_id}", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/tokens/{token_id}", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Revoke Token

DELETE/api/v1/docs/tokens/{token_id}

Revoke an access token. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/tokens/{token_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/tokens/{token_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/tokens/{token_id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/tokens/{token_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Export Project

GET/api/v1/docs/projects/{project_id}/export

Export all project pages as a ZIP of markdown files.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/export" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/export",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/export", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/export", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Webhooks

GET/api/v1/docs/webhooks

List webhooks for the brand. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/webhooks" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/webhooks",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/webhooks", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/webhooks", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Webhook

POST/api/v1/docs/webhooks

Create a webhook endpoint. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/webhooks" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/webhooks",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/webhooks", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/webhooks", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Delete Webhook

DELETE/api/v1/docs/webhooks/{webhook_id}

Delete a webhook. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/webhooks/{webhook_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/webhooks/{webhook_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/webhooks/{webhook_id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/webhooks/{webhook_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Templates

GET/api/v1/docs/templates

List available page templates (system + brand-specific).

Request

curl "https://app.opvs.ai/api/v1/docs/templates" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/templates",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/templates", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/templates", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Create Template

POST/api/v1/docs/templates

Create a brand-specific page template. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/templates" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/templates",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/templates", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/templates", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Delete Template

DELETE/api/v1/docs/templates/{template_id}

Delete a brand-specific template. Cannot delete system templates. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/templates/{template_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/templates/{template_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/templates/{template_id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/templates/{template_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api List Project Members

GET/api/v1/docs/projects/{project_id}/members

List members of a project.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/members", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Add Project Member

POST/api/v1/docs/projects/{project_id}/members

Add a member (user or agent) to a project. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "POST",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/members", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("POST", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Remove Project Member

DELETE/api/v1/docs/projects/{project_id}/members/{member_type}/{member_id}

Remove a member from a project. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members/{member_type}/{member_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members/{member_type}/{member_id}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/members/{member_type}/{member_id}", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("DELETE", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/members/{member_type}/{member_id}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Update Visibility

PATCH/api/v1/docs/projects/{project_id}/visibility

Update project visibility. Automatically manages members on transitions. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/projects/{project_id}/visibility" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/visibility",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/visibility", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/visibility", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Update Page Visibility

PATCH/api/v1/docs/projects/{project_id}/pages/{slug}/visibility

Update a single page's visibility (public/private). Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/visibility" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/visibility",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/visibility", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages/{slug}/visibility", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Bulk Update Page Visibility

PATCH/api/v1/docs/projects/{project_id}/pages-visibility

Bulk update visibility for multiple pages. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages-visibility" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PATCH",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages-visibility",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages-visibility", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PATCH", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/pages-visibility", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Project View

GET/api/v1/docs/projects/{project_id}/view

Full project overview in agent-readable format (markdown, YAML, or JSON).

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/view" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/view",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/view", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/view", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Page View

GET/api/v1/docs/projects/{project_id}/page-view/{slug}

Single page with content in agent-readable format.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/page-view/{slug}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/page-view/{slug}",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/page-view/{slug}", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/page-view/{slug}", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Search View

GET/api/v1/docs/search/view

Search results in agent-readable format.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/search/view" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/search/view",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/search/view", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/search/view", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Get Docs Graph

GET/api/v1/docs/projects/{project_id}/graph

Return pages + saved node positions + cross-references for Knowledge Canvas.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}"},
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}` },
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("GET", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph", nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Api Save Docs Positions

PUT/api/v1/docs/projects/{project_id}/graph/positions

Save per-user node positions for Knowledge Canvas.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PUT "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph/positions" \
  -H "Authorization: Bearer $OPVS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

import os
import requests

r = requests.request(
    "PUT",
    "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph/positions",
    headers={"Authorization": f"Bearer {os.environ['OPVS_TOKEN']}", "Content-Type": "application/json"},
    data='{}',
)
r.raise_for_status()
print(r.json())

const r = await fetch("https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph/positions", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.OPVS_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({}),
});
if (!r.ok) throw new Error(String(r.status));
console.log(await r.json());

req, _ := http.NewRequest("PUT", "https://app.opvs.ai/api/v1/docs/projects/{project_id}/graph/positions", strings.NewReader(`{}`))
req.Header.Set("Authorization", "Bearer "+os.Getenv("OPVS_TOKEN"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

Did this answer your question?

Need help? support@opvs.aiChangelog LLM? Read llms.txt