Backup & Restore

Best for endpoint payloads, auth methods, filters, and operational capabilities.

Overview

Backup & Restore is framed as an execution surface instead of a generic article. Use it when you need direct context, concise operational detail, and a fast path into api reference.

Concepts

article

API Reference

Complete reference for the Piri REST API.

shield

Authentication

Response:

view_in_ar

Collections API

Response:

Agentic Tools

api_reference_backup_restore.json

{
  "tool_name": "api_reference_backup_restore",
  "scope": "API Reference",
  "description": "API Reference",
  "parameters": {
    "workspace": "default",
    "surface": "api-reference",
    "focus": "Backup & Restore",
    "mode": "reference"
  }
}

Implementation

docs_api_reference.ts

import { PiriClient } from '@piri/sdk'

const client = new PiriClient({
  apiKey: process.env.PIRI_API_KEY!,
  baseUrl: process.env.PIRI_BASE_URL!,
})

async function runDocsFlow() {
  const result = await client.request('/v1/query', {
    method: 'POST',
    body: {
      page: 'Backup & Restore',
      section: 'API Reference',
      intent: 'load'
    }
  })

  return result
}

runDocsFlow().then(console.log)