viewengine/viewengine.console
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README with correct repository URLs and support info

Browse Source
This commit is contained in:
David H. Friedel Jr. 2025-12-28 18:56:57 +00:00
parent f5d7701fd2
commit 75a976e701
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,6 +1,12 @@
# ViewEngine Console Demo
# ViewEngine.Console
This console application demonstrates how to use the ViewEngine REST API with an API key.
A sample console application demonstrating how to use the [ViewEngine.Client](https://git.marketally.com/viewengine/ViewEngine.Client) library to interact with the ViewEngine REST API.
## Installation
```bash
dotnet add package ViewEngine.Client
```
## What it does
@ -11,9 +17,9 @@ This console application demonstrates how to use the ViewEngine REST API with an
## Prerequisites
1. **ViewEngine.API must be running** on `http://localhost:5072`
2. **You need an API key** from the web application:
- Log in to the web app at http://localhost:5072
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!)
@ -129,7 +135,7 @@ You forgot to provide an API key. Run with `dotnet run <your-api-key>` or enter
Your API key is invalid or has been revoked. Create a new one in the web app.
### "API not responding"
Make sure ViewEngine.API is running on http://localhost:5072
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:
@ -156,4 +162,15 @@ This demo shows the MCP endpoints, but ViewEngine also has:
- **Feeder API** (`/v1/feeders/*`) - For feeder client applications
- **Billing API** (`/v1/billing/*`) - Check earnings and pricing
See the API documentation for more details.
See the full API documentation at https://www.viewengine.io/docs
## Support
- **Documentation**: https://www.viewengine.io/docs
- **Client Library**: https://git.marketally.com/viewengine/ViewEngine.Client
- **Issues**: https://git.marketally.com/viewengine/ViewEngine.Console/issues
- **Email**: support@marketally.com
## License
MIT License - Copyright © 2025 MarketAlly