How do I install the Ivx Cf API Design skill?

Run npx skillmds@latest add intelli-verse-x/ivx-cf-api-design in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Ivx Cf API Design safe to use?

SkillMD's automated safety review verdict for this skill is PASS. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Ivx Cf API Design?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Ivx Cf API Design free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Ivx Cf API Design?

intelli-verse-x (@intelli-verse-x) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Ivx Cf API Design by intelli-verse-x

Name: Ivx Cf API Design
Rating: 4.5 (4 reviews)
Author: intelli-verse-x

File contents

API Design Skill

Purpose

Design APIs that are intuitive, consistent, evolvable, and well-documented.

Design Principles

Resource-oriented: Nouns, not verbs (/tasks not /createTask)
Predictable: Consistent patterns across all endpoints
Self-descriptive: Clear error messages, hypermedia where appropriate
Evolvable: Backward compatible changes, clear deprecation

URL Structure

/api/v1/{resource}           # Collection
/api/v1/{resource}/{id}      # Single resource
/api/v1/{resource}/{id}/{subresource}  # Sub-collection

HTTP Methods

Method	Collection	Single Resource
GET	List (paginated)	Retrieve
POST	Create	N/A
PUT	Bulk update	Full update
PATCH	N/A	Partial update
DELETE	N/A	Delete

Request/Response

Success

{
  "success": true,
  "data": { ... },
  "meta": { "page": 1, "limit": 20, "total": 100 }
}

Error

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input",
    "details": [{"field": "duration", "issue": "must be >= 5"}]
  }
}

Validation

Pydantic models for all bodies
Field validators with clear messages
Business rules in service layer
Return 422 for validation errors with detailed info

Versioning

URL path: /api/v1/, /api/v2/
Deprecation: Sunset header, 6-month notice
Breaking changes → new version
Document migration path

Pagination

GET /api/v1/tasks?page=1&limit=20

Cursor-based for large datasets (better perf)
Offset-based for small, stable datasets
Always include total, has_more

Idempotency

Idempotency-Key header for POST/PUT/PATCH
Key scoped to resource + operation
TTL: 24 hours minimum
Return cached response for replay

CF-Specific

All pipelines: POST /api/pipelines/{kind}
Task status: GET /api/pipelines/tasks/{id}
Harvest: GET /api/pipelines/tasks/{id}/harvest
Tags in request for operator-loop discovery

---name: ivx-cf-api-designdescription: Design RESTful and GraphQL APIs with proper validation, versioning, and documentation. Use when creating new endpoints, designing request/response models, or reviewing API contracts.---# API Design Skill## PurposeDesign APIs that are intuitive, consistent, evolvable, and well-documented.## Design Principles1. **Resource-oriented**: Nouns, not verbs (`/tasks` not `/createTask`)2. **Predictable**: Consistent patterns across all endpoints3. **Self-descriptive**: Clear error messages, hypermedia where appropriate4. **Evolvable**: Backward compatible changes, clear deprecation## URL Structure```/api/v1/{resource} # Collection/api/v1/{resource}/{id} # Single resource/api/v1/{resource}/{id}/{subresource} # Sub-collection```## HTTP Methods| Method | Collection | Single Resource ||--------|-----------|----------------|| GET | List (paginated) | Retrieve || POST | Create | N/A || PUT | Bulk update | Full update || PATCH | N/A | Partial update || DELETE | N/A | Delete |## Request/Response### Success```json{ "success": true, "data": { ... }, "meta": { "page": 1, "limit": 20, "total": 100 }}```### Error```json{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "Invalid input", "details": [{"field": "duration", "issue": "must be >= 5"}] }}```## Validation- Pydantic models for all bodies- Field validators with clear messages- Business rules in service layer- Return 422 for validation errors with detailed info## Versioning- URL path: `/api/v1/`, `/api/v2/`- Deprecation: `Sunset` header, 6-month notice- Breaking changes → new version- Document migration path## Pagination```GET /api/v1/tasks?page=1&limit=20```- Cursor-based for large datasets (better perf)- Offset-based for small, stable datasets- Always include `total`, `has_more`## Idempotency- `Idempotency-Key` header for POST/PUT/PATCH- Key scoped to resource + operation- TTL: 24 hours minimum- Return cached response for replay## CF-Specific- All pipelines: `POST /api/pipelines/{kind}`- Task status: `GET /api/pipelines/tasks/{id}`- Harvest: `GET /api/pipelines/tasks/{id}/harvest`- Tags in request for operator-loop discovery

Frequently asked questions

Ivx Cf API Design