/ developer portal, openapi & sandbox

Developer Portal & OpenAPI Spec

Welcome to the official developer and agent portal for the Kartikey Sharma Portfolio. This portal provides an OpenAPI 3.1.0 specification, structured JSON APIs compatible with LLM function calling, quickstart guides, and an interactive sandbox environment.

1. OpenAPI 3.1.0 Specification

Agents and LLM tools can inspect the complete API schema automatically:

JSON Specification: https://www.kartikeysharmaks.in/openapi.json

YAML Specification: https://www.kartikeysharmaks.in/api/openapi.yaml

OpenAPI 3.1.0 Function Calling Ready Strict JSON Schema

2. Function Calling Endpoints (LLM Compatible)

All operations are self-describing with unique operation IDs and typed response schemas:

getProfile — GET /api/profile.json

Retrieve complete verified developer profile of Kartikey Sharma, including full bio, contact details, categorized skills, and social profiles.

getSkills — GET /api/skills.json

Retrieve categorized technical skills: languages, frontend, backend, databases, and DevOps tools.

getProjects — GET /api/projects.json

Retrieve featured software engineering projects, tech stacks, and live links.

getContactInfo — GET /api/contact.json

Retrieve official contact channels, email address, physical location, and social links.

getTravelInfo — GET /api/travel.json

Retrieve travel creator destinations and regional media across Uttarakhand and India.

GET / — Markdown Content Negotiation

Send header Accept: text/markdown to receive the markdown body (acceptmarkdown.com compliant) with Vary: Accept.

3. Structured JSON Error Responses

All API requests returning error statuses (400, 404, 405, 500) provide structured JSON with error codes, human-readable messages, and actionable resolution hints:

{
  "error": {
    "code": "not_found",
    "message": "The requested API endpoint was not found on this server.",
    "status": 404,
    "resolution": "Check the OpenAPI specification at https://www.kartikeysharmaks.in/openapi.json or consult https://www.kartikeysharmaks.in/developers/."
  }
}

4. API Keys & Access Authentication

Public Read Access

No authorization headers are strictly required for public read endpoints. Agents may identify themselves or include a sandbox client key for tracking:

Authorization: Bearer ks_live_public_read_portfolio

Scope: read:profile Scope: read:skills Rate limit: 120 req/min

5. Quickstart Guides

cURL

# Fetch OpenAPI 3.1.0 specification
curl -s https://www.kartikeysharmaks.in/openapi.json

# Fetch structured JSON profile
curl -s https://www.kartikeysharmaks.in/api/profile.json

# Test Markdown content negotiation on homepage
curl -sS -L -i -H 'Accept: text/markdown' https://www.kartikeysharmaks.in/

JavaScript / TypeScript

const response = await fetch("https://www.kartikeysharmaks.in/api/profile.json", {
  headers: { "Accept": "application/json" }
});
const profile = await response.json();
console.log(profile.name, profile.skills);

Python

import requests

res = requests.get(
    "https://www.kartikeysharmaks.in/",
    headers={"Accept": "text/markdown"}
)
print(res.text)

6. Interactive API Sandbox

Test live responses and error handling directly within your browser:

Ready for request
Click any endpoint button above to execute a live request...

7. Official CLI Tool

Script interactions from your terminal via `npx`:

npx kartikeysharmaks
npx kartikeysharmaks --json
npx kartikeysharmaks --skills
npx kartikeysharmaks --projects

8. Support & Integration Inquiries

For inquiries regarding API integrations, custom freelance projects, or software collaboration, email kartikeysharma1616@gmail.com.