API Overview - CommitKey Documentation

The CommitKey API is a RESTful API that provides programmatic access to Git operations. All API endpoints use HTTPS and return JSON responses.

Base URL

All API requests should be made to:

https://api.commitkey.dev/v1

Authentication

The CommitKey API uses API key authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are rate limited to ensure fair usage:

Free Tier: 1,000 requests per hour
Pro Tier: 10,000 requests per hour
Enterprise: Custom limits

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Response Format

All API responses follow a consistent format:

Success Response

{
  "data": {
    // Response data
  },
  "meta": {
    "request_id": "req_123456789",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Error Response

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request was invalid",
    "details": {
      "field": "name",
      "reason": "required"
    }
  },
  "meta": {
    "request_id": "req_123456789",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

HTTP Status Codes

200 - Success
201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
429 - Rate Limited
500 - Internal Server Error

SDKs and Libraries

We provide official SDKs for popular languages:

Webhooks

CommitKey supports webhooks for real-time notifications:

Repository events (push, pull request, etc.)
User events (signup, team changes)
Billing events (subscription changes)

Learn more about webhooks.