viewengine/viewengine.console
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Console sample for ViewEngine https://viewengine.io/
3 Commits 1 Branch 0 Tags 36 KiB
C# 100%
master
Go to file
Dave Friedel ccbca5bfd6 fixes for AI nav
2025-12-31 17:43:23 -05:00
.gitignore Initial commit - ViewEngine.Console sample 2025-12-28 18:25:44 +00:00
Program.cs fixes for AI nav 2025-12-31 17:43:23 -05:00
README.md fixes for AI nav 2025-12-31 17:43:23 -05:00
ViewEngine.Console.csproj Initial commit - ViewEngine.Console sample 2025-12-28 18:25:44 +00:00

README.md

ViewEngine.Console

A sample console application demonstrating how to use the ViewEngine.Client library to interact with the ViewEngine REST API.

Installation

dotnet add package ViewEngine.Client

What it does

  1. Discovers MCP Tools - Calls GET /mcp/tools to list available endpoints
  2. Submits Retrieve Request - Calls POST /mcp/retrieve to start a web page retrieval job
  3. Polls for Results - Calls GET /mcp/retrieve/{requestId} repeatedly until the job completes
  4. Downloads Content - Optionally downloads the retrieved page data

Prerequisites

  1. ViewEngine API access - Either use the hosted API at https://www.viewengine.io or run locally
  2. You need an API key - Get one from https://www.viewengine.io:
    • Sign up or log in
    • Go to Settings → API Keys
    • Create a new API key
    • Copy the key (it's only shown once!)

How to Run

Option 1: With command-line argument

cd ViewEngine.Console
dotnet run <your-api-key>

Option 2: Interactive mode

cd ViewEngine.Console
dotnet run

You'll be prompted to enter your API key.

Example Output

╔══════════════════════════════════════════════════════════╗
║          ViewEngine REST API Demo                       ║
║  Demonstrates using the MCP endpoints with an API key   ║
╚══════════════════════════════════════════════════════════╝

Enter your API key: ak_********************************

🔍 Step 1: Discovering available MCP tools...

✅ Found 2 available tools:
   • retrieve_url: Retrieve a web page and extract its content...
   • get_retrieve_status: Check the status of a retrieval job...

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Enter a URL to retrieve (or press Enter for example.com):

🌐 Step 2: Submitting retrieval request for https://example.com...

✅ Request submitted successfully!
   Request ID: 12345678-1234-1234-1234-123456789012
   Status: queued
   Estimated wait: 30s

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

⏳ Step 3: Polling for results (this may take a while)...

   [1/60] Status: queued - Retrieval queued. Waiting for available feeder.
   [2/60] Status: processing - Retrieval in progress...
   [3/60] Status: complete - Retrieval completed successfully.

✅ Retrieval completed!
   Status: complete
   URL: https://example.com
   Completed at: 2025-01-15 10:30:45

📄 Content available:
   Page Data URL: https://storage.example.com/...
   Content Hash: abc123...
   Artifacts: screenshot, thumbnail
   Metrics: load_time_ms, dom_size

Download page content? (y/n): y

⬇️  Downloading page content...

📄 Page Content (first 500 chars):
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
{
  "url": "https://example.com",
  "title": "Example Domain",
  "text_content": "This domain is for use in illustrative examples...",
  "html": "<html>...</html>",
  ...
}
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

✅ Demo completed successfully!

Press any key to exit...

API Endpoints Used

Endpoint Method Purpose
/v1/mcp/tools GET List available MCP tools
/v1/mcp/retrieve POST Submit a page retrieval request
/v1/mcp/retrieve/{id} GET Get retrieval status and results

Authentication

All requests include the API key in the X-API-Key header:

X-API-Key: ak_your-api-key-here

Troubleshooting

"API key is required"

You forgot to provide an API key. Run with dotnet run <your-api-key> or enter it when prompted.

"Error: Unauthorized"

Your API key is invalid or has been revoked. Create a new one in the web app.

"API not responding"

Make sure the ViewEngine API is accessible at https://www.viewengine.io or your configured endpoint

"Timeout: Maximum polling attempts reached"

The retrieval job took longer than expected. This usually means:

  • No feeder clients are online to process the job
  • The feeder client crashed or couldn't complete the job
  • Check the API logs for more details

Code Structure

The console app is organized into clear methods:

  • Main() - Entry point, handles API key input
  • RunDemoAsync() - Orchestrates the demo flow
  • GetMcpToolsAsync() - Calls GET /v1/mcp/tools
  • SubmitRetrieveRequestAsync() - Calls POST /v1/mcp/retrieve
  • PollForResultsAsync() - Repeatedly calls GET /v1/mcp/retrieve/{id}
  • DownloadPageDataAsync() - Downloads the retrieved content

Next Steps

This demo shows the MCP endpoints, but ViewEngine also has:

  • Ingest API (/v1/ingest/*) - Submit retrieval jobs programmatically
  • Feeder API (/v1/feeders/*) - For feeder client applications
  • Billing API (/v1/billing/*) - Check earnings and pricing

See the full API documentation at https://www.viewengine.io/docs

Support

License

MIT License - Copyright © 2025 MarketAlly