🐕 Ghonchu GPT API Documentation

Learn how to integrate with Ghonchu GPT API for text generation, rewriting, and translation features

Quick Start 🎾

1. Get API Keys

Create an app in your dashboard to get App ID and App Secret

2. Make API Calls

Use your credentials to authenticate and call our endpoints

3. Build Amazing Apps

Integrate AI-powered features into your applications

🔑 Base URL: https://ghonchu-gpt-backend.vercel.app/

Authentication 🔐

All API requests require authentication using your App ID and App Secret. Include these in the request headers.

Headers Required:

http

X-App-ID: your_app_id_here
X-App-Secret: your_app_secret_here
Content-Type: application/json

Example Request:

javascript

const response = await fetch('{BASE_URL}/api/ai/generate', {
  method: 'POST',
  headers: {
    'X-App-ID': 'ghonchu_abc123def456',
    'X-App-Secret': 'sk_secret123456789',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    prompt: 'Write a story about a golden retriever',
  
  })
});

const data = await response.json();
console.log(data.response);

⚠️Error Handling

The API returns standard HTTP status codes and structured error responses:

Common Status Codes:

200

Success

400

Bad Request - Invalid parameters

401

Unauthorized - Invalid credentials

403

Forbidden - App not approved or feature disabled

429

Rate Limit Exceeded

500

Internal Server Error

Error Response Format:

json

{
  "success": false,
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "Invalid App ID or App Secret",
    "details": "Please check your authentication credentials"
  },
  "timestamp": "2024-01-15T10:30:00Z"
}

⏱️Rate Limits & Usage

Rate Limits:

Free Tier:100 requests/hour

Pro Tier:1,000 requests/hour

Enterprise:Custom limits

Response Headers:

X-RateLimit-Limit - Request limit per hour

X-RateLimit-Remaining - Requests remaining

X-RateLimit-Reset - Reset time (Unix timestamp)

SDKs & Libraries 📚

🟨

JavaScript/Node.js

Official SDK coming soon

🐍

Python

Official SDK coming soon

♦️

Ruby

Official SDK coming soon

🐕💝

Need Help?

Ghonchu is here to help! If you have questions about the API or need assistance with integration, don't hesitate to reach out to our support team.