Backend API Response

Use when the user asks about API response format, ApiResponse<T> envelope, error codes, Problem Details (RFC 9457), validation error responses or pagination envelopes. Produces a uniform success/error response contract. Not for endpoint and URL design (use backend-api-design).

45 stars 6 forksSoftware Development

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add j4flmao/agent-skills --skill backend-api-response
Manual install
git clone --depth 1 https://github.com/j4flmao/agent-skills.git /tmp/agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/agent-skills/skills/backend/universal/api-response ~/.claude/skills/backend-api-response

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# API Response Design

## Purpose
Define and enforce a universal API response contract with standardized envelopes, error codes, and pagination. Every response must be predictable regardless of success or failure.

## Agent Protocol

### Trigger
User request includes: `api response`, `response envelope`, `response<T>`, `api error`, `exception handling`, `error code`, `api contract`, `pagination response`, `api standard`.

### Input Context
- Current API response format (if refactoring)
- Technology stack (language/framework)
- Error handling strategy (exceptions, result types, error codes)
- Pagination requirements

### Output Artifact
A markdown document containing:
- Response envelope structure (Response<T> with status, data, error, metadata)
- Error response format (error code, message, details, trace ID)
- Exception handling strategy (global handler, middleware, filter)
- Pagination envelope (page, pageSize, totalCount, totalPages)
- Validation error format (field-level errors)
- Success response rules (HTTP status codes per operation)

### Response Format
Produce the artifact directly. No preamble, no postamble, no explanations. No filler, no hedging, no transitions. Strip articles a/an/the where unambiguous. Compress output. If response format already standardized, output `API response standard already defined at: [path].` and stop.

### Completion Criteria
- [ ] Envelope structure defined for success, error, validation, pagination
Read the full skill on GitHub

Details

Skill name
backend-api-response
Path
skills/backend/universal/api-response/SKILL.md
License
MIT
Repo updated
17 November 2026

FAQ

What does the Backend API Response skill do?

Use when the user asks about API response format, ApiResponse<T> envelope, error codes, Problem Details (RFC 9457), validation error responses or pagination envelopes. Produces a uniform success/error response contract. Not for endpoint and URL design (use backend-api-design).

How do I install the Backend API Response skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add j4flmao/agent-skills --skill backend-api-response. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Backend API Response popular?

It lives in j4flmao/agent-skills, which has 45 GitHub stars and 6 forks.

Related skills

Agent Observability

45

j4flmao/agent-skills

Use when the user asks about agent observability, tracing agent reasoning, debugging an agent loop, OpenTelemetry GenAI spans for LLM calls, LLM cost tracking per agent, agent audit logs or hallucination/eval monitoring in production. Produces instrumentation config, trace schema, dashboards, alerts and cost attribution. Not for generic service tracing without LLMs (use devops-opentelemetry).

DevOps & Cloud

AI Agent Architectures

45

j4flmao/agent-skills

Use when the user asks to build an AI agent, design an agent that calls tools and keeps memory, write an agent system prompt or pick an agent framework (Claude Agent SDK, OpenAI Agents SDK, LangGraph). Produces an architecture brief covering loop, tools, memory, guardrails and evals, routing depth to child skills. Not for workflow patterns (use ai-agentic-workflows).

AI, LLMs & Agents

AI Agent Core Loop

45

j4flmao/agent-skills

Use when the user asks about the agent loop, ReAct vs plan-and-solve, re-planning, Reflexion, an agent stuck in a loop, max iterations or termination conditions. Produces a loop spec or patch with state, success predicate, caps and no-progress detection. Not for overall agent design (use ai-agent-architectures) or tool schemas (use tool-calling-principles).

AI, LLMs & Agents

Backend API Versioning

45

j4flmao/agent-skills

Use when the user asks about API versioning, URI vs header versioning, breaking changes, deprecating or sunsetting an endpoint, Deprecation and Sunset headers or API migration. Produces a versioning and deprecation plan. Not for API product strategy (use api-product-management).

Software Development

Backend API Design

45

j4flmao/agent-skills

Use when the user asks about REST API design, designing REST endpoints, URL and resource naming, HTTP methods and status codes, pagination, filtering or error formats. Produces endpoint contracts with conventions. Not for the response envelope (use backend-api-response) or versioning (use backend-api-versioning).

Software Development

Backend Audit Logging

45

j4flmao/agent-skills

Use when the user asks about audit logs, audit trail, who changed what, tamper-evident or append-only logs, hash chains, SOC 2 audit evidence or change tracking tables. Produces an immutable audit trail design and code. Not for application logs (use backend-structured-logging).

Software Development

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.