Workspace Planner

List Plans

GET/api/v1/planner/plans

Also as:MCPtool_call workspace-planner.listPlansskillworkspace-planner

List workspace plans for the current brand.

Errors

Code	When	What to do
422	Validation Error	—

Request

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

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans",
    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/planner/plans", {
  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/planner/plans", 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()

Try itGET /api/v1/planner/plans

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Create Plan

POST/api/v1/planner/plans

Also as:MCPtool_call workspace-planner.createPlanskillworkspace-planner

Start a new workspace plan. Creates planner board. One active plan per brand.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans" \
  -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/planner/plans",
    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/planner/plans", {
  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/planner/plans", 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()

Try itPOST /api/v1/planner/plans

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Plan

GET/api/v1/planner/plans/{plan_id}

Also as:MCPtool_call workspace-planner.getPlanskillworkspace-planner

Get plan state. Agent reads this on session start.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_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/planner/plans/{plan_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/planner/plans/{plan_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()

Try itGET /api/v1/planner/plans/{plan_id}

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Update Plan

PATCH/api/v1/planner/plans/{plan_id}

Also as:MCPtool_call workspace-planner.updatePlanStatusskillworkspace-planner

Update plan metadata (status transitions).

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/planner/plans/{plan_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/planner/plans/{plan_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/planner/plans/{plan_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/planner/plans/{plan_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()

Try itPATCH /api/v1/planner/plans/{plan_id}

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Archive Plan

DELETE/api/v1/planner/plans/{plan_id}

Also as:MCPtool_call workspace-planner.archivePlanskillworkspace-planner

Archive a plan (soft delete). Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X DELETE "https://app.opvs.ai/api/v1/planner/plans/{plan_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "DELETE",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_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/planner/plans/{plan_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/planner/plans/{plan_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()

Try itDELETE /api/v1/planner/plans/{plan_id}

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Update Context

POST/api/v1/planner/plans/{plan_id}/context

Also as:MCPtool_call workspace-planner.updateDiscoveryContextskillworkspace-planner

Update discovery_context with extracted facts. Agent calls after each exchange.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/context" \
  -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/planner/plans/{plan_id}/context",
    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/planner/plans/{plan_id}/context", {
  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/planner/plans/{plan_id}/context", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/context

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Progress

GET/api/v1/planner/plans/{plan_id}/progress

Also as:MCPtool_call workspace-planner.getDiscoveryProgressskillworkspace-planner

Get discovery progress checklist.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/progress" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/progress",
    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/planner/plans/{plan_id}/progress", {
  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/planner/plans/{plan_id}/progress", 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()

Try itGET /api/v1/planner/plans/{plan_id}/progress

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Upload Context Doc

POST/api/v1/planner/plans/{plan_id}/upload

Also as:MCPtool_call workspace-planner.uploadDocumentskillworkspace-planner

Upload a context document (PDF, DOCX, CSV, text, JSON). Stores as AgentDocs page.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/upload" \
  -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/planner/plans/{plan_id}/upload",
    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/planner/plans/{plan_id}/upload", {
  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/planner/plans/{plan_id}/upload", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/upload

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Upload Content

GET/api/v1/planner/plans/{plan_id}/upload/{page_id}

Also as:MCPtool_call workspace-planner.getUploadContentskillworkspace-planner

Get the full extracted text of an uploaded document. Used by the planner agent.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/upload/{page_id}" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/upload/{page_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/planner/plans/{plan_id}/upload/{page_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/planner/plans/{plan_id}/upload/{page_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()

Try itGET /api/v1/planner/plans/{plan_id}/upload/{page_id}

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Analyze Upload

POST/api/v1/planner/plans/{plan_id}/upload/{page_id}/analyze

Also as:MCPtool_call workspace-planner.analyzeUploadskillworkspace-planner

Trigger AI analysis of an uploaded document. Agent calls after upload.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/upload/{page_id}/analyze" \
  -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/planner/plans/{plan_id}/upload/{page_id}/analyze",
    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/planner/plans/{plan_id}/upload/{page_id}/analyze", {
  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/planner/plans/{plan_id}/upload/{page_id}/analyze", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/upload/{page_id}/analyze

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Generate Blueprint

POST/api/v1/planner/plans/{plan_id}/blueprint/generate

Also as:MCPtool_call workspace-planner.generateBlueprintskillworkspace-planner

Generate a workspace blueprint from discovery context. Agent calls via skill.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/blueprint/generate" \
  -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/planner/plans/{plan_id}/blueprint/generate",
    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/planner/plans/{plan_id}/blueprint/generate", {
  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/planner/plans/{plan_id}/blueprint/generate", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/blueprint/generate

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Blueprint

GET/api/v1/planner/plans/{plan_id}/blueprint

Also as:MCPtool_call workspace-planner.getBlueprintskillworkspace-planner

Get the current blueprint. Agent reads this to present conversationally.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/blueprint" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/blueprint",
    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/planner/plans/{plan_id}/blueprint", {
  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/planner/plans/{plan_id}/blueprint", 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()

Try itGET /api/v1/planner/plans/{plan_id}/blueprint

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Edit Blueprint

PATCH/api/v1/planner/plans/{plan_id}/blueprint

Also as:MCPtool_call workspace-planner.editBlueprintskillworkspace-planner

Apply edits to the blueprint. Creates a new AgentDocs revision.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X PATCH "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/blueprint" \
  -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/planner/plans/{plan_id}/blueprint",
    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/planner/plans/{plan_id}/blueprint", {
  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/planner/plans/{plan_id}/blueprint", 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()

Try itPATCH /api/v1/planner/plans/{plan_id}/blueprint

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Approve Blueprint

POST/api/v1/planner/plans/{plan_id}/blueprint/approve

Also as:MCPtool_call workspace-planner.approveBlueprintskillworkspace-planner

Approve the blueprint. Brand admin only. Transitions to approved status.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/blueprint/approve" \
  -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/planner/plans/{plan_id}/blueprint/approve",
    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/planner/plans/{plan_id}/blueprint/approve", {
  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/planner/plans/{plan_id}/blueprint/approve", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/blueprint/approve

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Provisioning

GET/api/v1/planner/plans/{plan_id}/provisioning

Also as:MCPtool_call workspace-planner.getProvisioningskillworkspace-planner

Get provisioning status and log.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/provisioning" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/provisioning",
    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/planner/plans/{plan_id}/provisioning", {
  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/planner/plans/{plan_id}/provisioning", 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()

Try itGET /api/v1/planner/plans/{plan_id}/provisioning

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Retry Provisioning

POST/api/v1/planner/plans/{plan_id}/provisioning/retry

Also as:MCPtool_call workspace-planner.retryProvisioningskillworkspace-planner

Retry failed provisioning steps. Brand admin only.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/provisioning/retry" \
  -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/planner/plans/{plan_id}/provisioning/retry",
    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/planner/plans/{plan_id}/provisioning/retry", {
  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/planner/plans/{plan_id}/provisioning/retry", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/provisioning/retry

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Quick Deploy Agent

POST/api/v1/planner/plans/{plan_id}/quick-deploy

Also as:MCPtool_call workspace-planner.quickDeployAgentskillworkspace-planner

Deploy a single agent from a template.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/quick-deploy" \
  -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/planner/plans/{plan_id}/quick-deploy",
    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/planner/plans/{plan_id}/quick-deploy", {
  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/planner/plans/{plan_id}/quick-deploy", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/quick-deploy

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Get Resources

GET/api/v1/planner/plans/{plan_id}/resources

Also as:MCPtool_call workspace-planner.getResourcesskillworkspace-planner

Get all resources created by provisioning.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/resources" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/resources",
    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/planner/plans/{plan_id}/resources", {
  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/planner/plans/{plan_id}/resources", 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()

Try itGET /api/v1/planner/plans/{plan_id}/resources

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Get Audit

GET/api/v1/planner/plans/{plan_id}/audit

Also as:MCPtool_call workspace-planner.getAuditskillworkspace-planner

Get latest audit findings.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/audit" \
  -H "Authorization: Bearer $OPVS_TOKEN"

import os
import requests

r = requests.request(
    "GET",
    "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/audit",
    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/planner/plans/{plan_id}/audit", {
  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/planner/plans/{plan_id}/audit", 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()

Try itGET /api/v1/planner/plans/{plan_id}/audit

Server fixedYour API token kept in this tab only

Used once, saved nowhere. Your token travels for this request through opvs.ai and SpiderPublish to app.opvs.ai, then this page forgets it when the tab closes.

GET only · 30 tries a minute

Trigger Audit

POST/api/v1/planner/plans/{plan_id}/audit

Also as:MCPtool_call workspace-planner.runAuditskillworkspace-planner

Trigger a workspace health audit. Agent calls this.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/audit" \
  -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/planner/plans/{plan_id}/audit",
    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/planner/plans/{plan_id}/audit", {
  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/planner/plans/{plan_id}/audit", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/audit

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Write Daily Note

POST/api/v1/planner/plans/{plan_id}/memory/daily-note

Also as:MCPtool_call workspace-planner.writeDailyNoteskillworkspace-planner

Append to today's daily log via Management API.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/memory/daily-note" \
  -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/planner/plans/{plan_id}/memory/daily-note",
    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/planner/plans/{plan_id}/memory/daily-note", {
  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/planner/plans/{plan_id}/memory/daily-note", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/memory/daily-note

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Add Learning

POST/api/v1/planner/plans/{plan_id}/memory/learning

Also as:MCPtool_call workspace-planner.addLearningskillworkspace-planner

Append a correction rule to LEARNINGS.md via Management API.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/memory/learning" \
  -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/planner/plans/{plan_id}/memory/learning",
    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/planner/plans/{plan_id}/memory/learning", {
  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/planner/plans/{plan_id}/memory/learning", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/memory/learning

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Save User Profile

POST/api/v1/planner/plans/{plan_id}/memory/user-profile

Also as:MCPtool_call workspace-planner.saveUserProfileskillworkspace-planner

Write/update user profile via Management API.

Errors

Code	When	What to do
422	Validation Error	—

Request

curl -X POST "https://app.opvs.ai/api/v1/planner/plans/{plan_id}/memory/user-profile" \
  -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/planner/plans/{plan_id}/memory/user-profile",
    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/planner/plans/{plan_id}/memory/user-profile", {
  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/planner/plans/{plan_id}/memory/user-profile", 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()

Try itPOST /api/v1/planner/plans/{plan_id}/memory/user-profile

Try it sends reading requests only.

This endpoint changes data in your workspace, so it is not sent from the docs. Copy the command and run it in your own terminal.

Did this answer your question?

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