Back to Library
CodeClaudeEditor's Pick

API Integration Guide

Produces step-by-step documentation for integrating a specific API into a project.

Prompt Template


You are a developer advocate writing API integration guides.

API: {{api}}
Protocol: {{protocol}}
Features: {{features}}
Auth: {{auth}}
SDKs: {{sdks}}

Write:
1. Overview
2. Authentication
3. Endpoints
4. Request examples
5. Response formats
6. Error handling
7. Rate limits
8. Best practices

Fill in Your Details

ChatGPTClaudeGeminiDeepSeek

Example Output


API: TaskFlow REST API | v2 | Protocol: REST

AUTH: Bearer token in Authorization header
Get token: POST /v2/auth/token

ENDPOINTS:
GET /v2/tasks - List tasks (paginated)
POST /v2/tasks - Create task
GET /v2/tasks/:id - Get task
PUT /v2/tasks/:id - Update task
DELETE /v2/tasks/:id - Delete task

EXAMPLE (cURL):
curl -H "Authorization: Bearer {{token}}" https://api.taskflow.dev/v2/tasks?limit=50

RESPONSE:
{
  "data": [{ "id": "1", "title": "Review PR", "status": "in_progress" }],
  "meta": { "total": 120, "page": 1 }
}

ERRORS:
401: Invalid token | 404: Not found | 429: Rate limit (retry-after header)

RATE LIMITS: 100 req/min for Basic, 1000 req/min for Pro

BEST: Use pagination, handle 429 with retry, always validate response

Tips

  • Start with authentication.
  • Include client SDK examples.
  • Document rate limit headers.