HiveForge

API Documentation

HiveForge API

Powerful REST API to integrate with your applications. Manage users, organizations, billing, and more with our comprehensive API endpoints.

Quick Start

Get started with the HiveForge API in minutes

1

Get your API key

Generate an API key from your dashboard settings

2

Make your first request

Use your API key to authenticate requests

3

Start building

Explore our endpoints and build amazing integrations

Base URL

https://api.hiveforge.dev

Authentication

Include your API key in the Authorization header:

Bearer YOUR_API_TOKEN

Example Request

curl -X GET "https://api.hiveforge.dev/auth/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
Get current user information

API Endpoints

Authentication

POST/auth/loginAuthenticate user and return access token
POST/auth/logoutInvalidate user session and token
Auth Required
POST/auth/refreshRefresh access token using refresh token
GET/auth/meGet current user profile information
Auth Required

Organizations

GET/organizationsList user's organizations
Auth Required
POST/organizationsCreate a new organization
Auth Required
GET/organizations/{id}Get organization details
Auth Required
PUT/organizations/{id}Update organization settings
Auth Required
DELETE/organizations/{id}Delete organization
Auth Required

Users

GET/organizations/{id}/usersList organization users
Auth Required
POST/organizations/{id}/usersInvite user to organization
Auth Required
PUT/organizations/{id}/users/{userId}Update user role and permissions
Auth Required
DELETE/organizations/{id}/users/{userId}Remove user from organization
Auth Required

Billing

GET/billing/subscriptionGet current subscription details
Auth Required
POST/billing/subscriptionCreate or update subscription
Auth Required
GET/billing/usageGet usage metrics for billing period
Auth Required
GET/billing/invoicesList billing invoices
Auth Required

Response Format

Standard Response Structure

All API responses follow a consistent structure

Success Response

{
  "success": true,
  "data": {
    "id": "usr_123",
    "email": "user@example.com",
    "name": "John Doe"
  },
  "message": "User retrieved successfully"
}

Error Response

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  },
  "details": {
    "timestamp": "2024-09-16T10:30:00Z"
  }
}

HTTP Status Codes

200OK
Request successful
201Created
Resource created successfully
400Bad Request
Invalid request parameters
401Unauthorized
Invalid or missing authentication
403Forbidden
Insufficient permissions
404Not Found
Resource not found
429Rate Limited
Too many requests
500Server Error
Internal server error

Rate Limiting

Request Limits

API rate limits to ensure fair usage and system stability

1,000
Free Plan
requests per hour
10,000
Pro Plan
requests per hour
100,000
Enterprise
requests per hour
Rate limit headers included in all responses
Automatic retry with exponential backoff recommended
Higher limits available for enterprise customers

SDKs & Libraries

Official and community-maintained libraries

JavaScript/TypeScriptnpm install @producthacker/hiveforge-sdk
Pythonpip install hiveforge
GoComing Soon
PHPComing Soon

Need Help?

Get support and connect with the community

Discord CommunityContact Support