read

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/volcengine/OpenViking/llms.txt

Use this file to discover all available pages before exploring further.

​

Python SDK

from openviking import OpenViking

client = OpenViking()

# Read entire file
content = client.read("viking://resources/docs/api.md")
print(content)

# Read with offset and limit
partial = client.read("viking://resources/docs/api.md", offset=100, limit=500)
print(partial)

​

HTTP API

curl -X GET "http://localhost:1933/api/v1/content/read?uri=viking://resources/docs/api.md" \
  -H "X-API-Key: your-key"

GET /api/v1/content/read?uri=viking://resources/docs/api.md

​

Parameters

​

Response

{
  "status": "ok",
  "result": "# API Documentation\n\nThis document describes the API...\n\n## Authentication\n\n...",
  "time": 0.1
}

​

CLI

openviking read viking://resources/docs/api.md

​

Context Layers

• L0 (Abstract): ~100 token summary via abstract()
• L1 (Overview): Structured overview via overview()
• L2 (Full): Complete content via read() (this method)

​

Error Cases

• Returns error if the URI points to a directory (use overview() for directories)
• Returns error if the file doesn’t exist
• For binary files, content may not be readable as text