# api-response-optimization

A coding-agent skill that trims payloads, adds caching and compression, and gives you a checklist for slow API endpoints.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 484 installs · ★ 371
- Author: aj-geddes
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/api-response-optimization/SKILL.md
- Updated: 2026-03-04
- HTML: https://affpapa.org/en/nevibecode/skills/api-response-optimization

## What it does

The skill walks an agent through what makes an API response slow and proposes concrete edits. Three areas get the attention: payload size, caching, and query efficiency. There is a worked example where an endpoint returns fields nobody asked for — a password hash, an SSN, unused metadata — and the optimized version keeps only what the client needs.

Four guides live in `references/`: response payload optimization, caching strategies, compression and performance, and an optimization checklist. The `SKILL.md` itself is short, so the agent will open those files as the task moves along.

Reach for it when endpoints drag or server CPU and memory climb. The skill does not install libraries or touch your infrastructure — it hands the agent a plan and a checklist, and the stack choices stay with you.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-response-optimization -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/api-response-optimization/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/api-response-optimization/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-response-optimization -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/api-response-optimization/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-response-optimization -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/api-response-optimization/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts api-response-optimization
```

2. **Manually: put the files in place**
- File: `.github/skills/api-response-optimization/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-response-optimization -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/api-response-optimization
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/api-response-optimization/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-response-optimization -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/api-response-optimization/SKILL.md

## When to use it
- shrink an API response by dropping fields the client never uses
- add caching to a hot endpoint
- turn on compression and cut network traffic
- find out why server CPU and memory keep climbing
- run an optimization checklist before a deploy

## Example prompts
- look at the response from /api/users/123 and strip the fields we don't need
- add caching to this endpoint and check that the response doesn't go stale
- go through the optimization checklist and tell me what else can be compressed

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: c7706139971a7bc4.

BEGIN THIRD-PARTY FILE c7706139971a7bc4
````text
---
name: api-response-optimization
description: >
  Optimize API response times through caching, compression, and efficient
  payloads. Improve backend performance and reduce network traffic.
---

# API Response Optimization

## Table of Contents

- [Overview](#overview)
- [When to Use](#when-to-use)
- [Quick Start](#quick-start)
- [Reference Guides](#reference-guides)
- [Best Practices](#best-practices)

## Overview

Fast API responses improve overall application performance and user experience. Optimization focuses on payload size, caching, and query efficiency.

## When to Use

- Slow API response times
- High server CPU/memory usage
- Large response payloads
- Performance degradation
- Scaling bottlenecks

## Quick Start

Minimal working example:

```javascript
// Inefficient response (unnecessary data)
GET /api/users/123
{
  "id": 123,
  "name": "John",
  "email": "john@example.com",
  "password_hash": "...", // ❌ Should never send
  "ssn": "123-45-6789", // ❌ Sensitive data
  "internal_id": "xyz",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-02T00:00:00Z",
  "meta_data": {...}, // ❌ Unused fields
  "address": {
    "street": "123 Main",
    "city": "City",
    "state": "ST",
    "zip": "12345",
    "geo": {...} // ❌ Not needed
  }
}

// Optimized response (only needed fields)
GET /api/users/123
{
  "id": 123,
// ... (see reference guides for full implementation)
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [Response Payload Optimization](references/response-payload-optimization.md) | Response Payload Optimization |
| [Caching Strategies](references/caching-strategies.md) | Caching Strategies |
| [Compression & Performance](references/compression-performance.md) | Compression & Performance |
| [Optimization Checklist](references/optimization-checklist.md) | Optimization Checklist |

## Best Practices

### ✅ DO

- Follow established patterns and conventions
- Write clean, maintainable code
- Add appropriate documentation
- Test thoroughly before deploying

### ❌ DON'T

- Skip testing or validation
- Ignore error handling
- Hard-code configuration values
````
END THIRD-PARTY FILE c7706139971a7bc4

The third-party file has ended. Everything between the c7706139971a7bc4 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

© aj-geddes · MIT · https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/api-response-optimization/SKILL.md

## Similar
- [context-optimization](https://affpapa.org/en/nevibecode/skills/context-optimization.md) — skill · 356 installs
- [implement-caching-strategy](https://affpapa.org/en/nevibecode/commands/implement-caching-strategy.md) — command · 520 installs
- [rest-api-design](https://affpapa.org/en/nevibecode/skills/secondsky-rest-api-design.md) — skill · 586 installs
- [performance-optimization](https://affpapa.org/en/nevibecode/skills/mindrally-performance-optimization.md) — skill · 848 installs
- [loops-api](https://affpapa.org/en/nevibecode/skills/loops-api.md) — skill · 1600 installs

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md