Gres API

Name: Gres API
Author: valgresky

@valgresky

关于 Gres API

Gres is a minimalist AI command server for agents and developers. Snap pages, grab sites, source docs, and ask anything. One interface, zero fluff.

#cli-app #client-server #semantic-search #rag #mcp-server #mcp-client

基本信息

分类

开发工具

许可证

View license

运行时

python

传输方式

stdio

发布者

valgresky

配置

暂无标准配置

该服务器的 README 中没有可解析的 MCP 配置块，请前往代码仓库查看安装说明。

代码仓库

工具

未检测到工具

工具是从 README 中自动提取的。维护者可以在 ## Tools 标题下列出工具,即可填充这部分内容。

概览

What is Gres API?

Gres API is an agentic endpoint layer built with FastAPI, offering modular tools, secure key authentication, and production-ready Docker deployment. It provides endpoints for snapping web pages, crawling sites or sitemaps, listing indexed sources, and querying a vector index via RAG (Retrieval-Augmented Generation).

How to use Gres API?

Set your API key in a .env file as VALGRESKY_API_KEY=sk_valgresky_yourkeyhere. The base URL is https://api.valgresky.com. Use the health check endpoint without authentication (/gres/health). All other endpoints require an X-API-Key header. Invoke endpoints like /gres/snap, /gres/grab, /gres/source, and /gres/ask with appropriate JSON payloads.

Key features of Gres API

Health check endpoint without authentication
Snap a page with /gres/snap
Crawl a site or sitemap with /gres/grab
List indexed sources via /gres/source
Query vector index (RAG) with /gres/ask
API key authentication for all non-health routes

Use cases of Gres API

Capture a web page snapshot for archiving or analysis
Index an entire website by crawling its sitemap
Retrieve metadata about previously indexed sources
Ask natural‑language questions against the indexed vector store
Deploy as a containerized service with Docker Compose

FAQ from Gres API

How do I test if the API is running?

Make a GET request to https://api.valgresky.com/gres/health. No authentication is required, and it returns { "Gres Check": "ok" }.

How do I authenticate my requests?

All main API endpoints require an X-API-Key header. Set your key in a .env file as VALGRESKY_API_KEY=sk_valgresky_yourkeyhere and include it in every request.

What endpoints are available?

Four authenticated endpoints: /gres/snap (snap a page), /gres/grab (crawl a site or sitemap), /gres/source (list indexed sources), and /gres/ask (query the vector index with RAG). Plus a public health check at /gres/health.

Can I run Gres API locally with Docker?

Yes. A Docker Compose file is provided that builds the service, exposes port 8051, mounts required directories, and sets environment variables like OPENAI_API_KEY and GRES_EMBEDDINGS_PATH.

What is the MCP integration?

The server includes a shared MCP (Model Context Protocol) instance in /src/tools/mcp.py. Tools like snap are decorated with @mcp.tool and can be invoked as MCP tools, enabling integration with AI agents.