Shriraj Patil Portfolio — Developer Portal

API documentation, quickstart guide, endpoint reference, and machine-readable resources for AI agents and developers.

Quickstart

Get started with the Shriraj Patil Portfolio API in under 30 seconds:

1. Check API Health

curl https://portfolio-shriraj.vercel.app/api/health

2. Fetch Portfolio as Markdown (for LLMs)

curl -H "Accept: text/markdown" https://portfolio-shriraj.vercel.app/

3. Send a Notification (POST)

curl -X POST https://portfolio-shriraj.vercel.app/api/notify \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello from an AI agent"}'

API Reference

Full machine-readable API specification: OpenAPI 3.1 JSON | OpenAPI 3.1 YAML

Method	Endpoint	Description	Auth
`GET`	`/`	Portfolio homepage — supports `Accept: text/markdown` content negotiation	None
`GET`	`/api/health`	API health check, version, and endpoint discovery	None
`POST`	`/api/notify`	Dispatch visitor analytics notification to Telegram	None (CORS restricted)
`GET`	`/index.md`	Full Markdown portfolio profile	None
`GET`	`/llms.txt`	LLM context index (llmstxt.org standard)	None
`GET`	`/llms-full.txt`	Comprehensive LLM context document	None
`GET`	`/openapi.json`	OpenAPI 3.1 specification (JSON)	None
`GET`	`/sitemap.xml`	XML sitemap	None

Authentication

The Shriraj Patil Portfolio API is fully public and unauthenticated. No API keys are required. All read endpoints are open to any client. The /api/notify endpoint is CORS-restricted to the portfolio origin.

Versioning and Deprecation Policy

The API follows semantic versioning. The current version is v1.0.0.

Version header: All API responses include an X-API-Version header.
Deprecation: Deprecated endpoints will include a Deprecation: true header and a Sunset header with the retirement date, at least 90 days in advance.
Breaking changes: Major version bumps will be communicated via the X-API-Version header and documented here.
Current status: No endpoints are deprecated. The Deprecation: false header confirms this.

Rate Limiting

All API endpoints include standard rate limit headers per RFC draft-ietf-httpapi-ratelimit-headers:

Header	Description	Value
`RateLimit-Limit`	Maximum requests per window	60
`RateLimit-Remaining`	Remaining requests in current window	Dynamic
`RateLimit-Reset`	Seconds until window resets	60
`Retry-After`	Seconds to wait (returned on 429)	60

If you receive a 429 Too Many Requests response, wait for the Retry-After duration before retrying.

Error Response Format

All API errors return structured JSON with consistent fields:

{
  "error": {
    "code": "INVALID_REQUEST_BODY",
    "message": "Missing required 'message' string field in request body.",
    "status": 400,
    "hint": "Provide a non-empty 'message' string in the JSON payload.",
    "documentation_url": "https://portfolio-shriraj.vercel.app/developers"
  }
}

Content Negotiation

The homepage (/) supports HTTP Accept header content negotiation per RFC 9110:

Accept: text/html — Returns the full interactive React portfolio
Accept: text/markdown — Returns clean Markdown profile for LLM consumption
Accept: application/json — Returns 406 with supported types list

All responses include a Vary: Accept, Accept-Encoding header for correct caching.

Machine-Readable Resources

Sandbox and Testing

All endpoints are live and testable without authentication. Use curl, Postman, or any HTTP client:

# Test JSON error handling
curl -s https://portfolio-shriraj.vercel.app/api/nonexistent | jq .

# Verify rate limit headers
curl -sI https://portfolio-shriraj.vercel.app/api/health | grep -i ratelimit

# Test content negotiation
curl -H "Accept: text/markdown" https://portfolio-shriraj.vercel.app/

Support and Contact

For questions, feedback, or integration support:

Email: shriraj399@gmail.com
GitHub: github.com/Shriraj888
LinkedIn: linkedin.com/in/shriraj-patil888