API Documentation

Integration Tools

Give the APIXP skill file to your AI coding assistant (Cursor, Claude, Copilot, ChatGPT…) — it documents authentication, every endpoint category, response format, error handling and rate limits, so the assistant can generate correct integration code against our API without reading the whole docs page.

Integrate the APIXP API.

Docs: https://www.api.xptools.site/docs
API base: https://www.api.xptools.site/api/v1
Auth: apikey query parameter (?apikey=YOUR_API_KEY)

Build:
1. GET /ai/gemini?q=... — AI chat
2. GET /tools/fake-address?country=US — fake data
3. Handle errors: { status, success: false, message }

Stack: [your framework here]

Introduction

APIXP provides a unified REST API for developers to access a wide range of services — from AI chat and image generation to social media downloads, tools, finance data, and utilities. Every endpoint follows the same authentication pattern and returns consistent JSON responses.

Authentication

All API requests require a valid apikey parameter. Include it as a query parameter for GET requests or in the request body for POST requests.

To obtain your own API key, sign in to your dashboard and visit the API Key page. Free users get a shared key with a daily limit.

Example Request

curl "http://localhost:3000/api/v1/ai/gemini?apikey=YOUR_API_KEY&q=Hello"

Base URL

All API endpoints are accessible under the following base URL:

Replace {category} and {endpoint} with the actual category and endpoint slug from the Endpoints section below.

Making Requests

APIXP supports both GET and POST methods depending on the endpoint. All endpoints follow the same pattern:

curl "http://localhost:3000/api/v1/ai/gemini?apikey=YOUR_KEY&q=Tell me a joke"

curl -X POST "http://localhost:3000/api/v1/tts/generate" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "YOUR_KEY",
    "text": "Hello, this is a test",
    "lang": "en",
    "accent": "US"
  }'

Response Format

All successful API responses follow a consistent JSON structure:

{
  "success": true,
  "data": {
    // Your requested data here
  }
}

The success field indicates whether the request was processed successfully. The data field contains the actual response payload.

Error Handling

When a request fails, the API returns an error response with a relevant HTTP status code:

{
  "success": false,
  "error": "Missing apikey parameter"
}

{
  "success": false,
  "error": "Rate limit exceeded. Try again later."
}

{
  "success": false,
  "error": "Missing required parameter: q"
}

Rate Limits

Rate limits depend on your subscription plan. Each plan has a daily request allowance that resets every 24 hours.

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Code Examples

Here are examples of how to use the API in different programming languages:

# Ask Gemini AI a question
curl "http://localhost:3000/api/v1/ai/gemini?apikey=YOUR_KEY&q=What%20is%20the%20capital%20of%20France%3F"

# Download a YouTube video
curl "http://localhost:3000/api/v1/downloaders/yt-dl?apikey=YOUR_KEY&url=https://youtu.be/dQw4w9WgXcQ"

# Check the weather
curl "http://localhost:3000/api/v1/utilities/wth?apikey=YOUR_KEY&city=London"

async function askGemini(question) {
  const res = await fetch(
    "http://localhost:3000/api/v1/ai/gemini?" +
    new URLSearchParams({ apikey: "YOUR_KEY", q: question })
  );
  const data = await res.json();
  if (data.success) {
    console.log(data.data.response);
  } else {
    console.error(data.error);
  }
}

askGemini("Tell me a fun fact about space");

import requests

def ask_gemini(question):
    params = {
        "apikey": "YOUR_KEY",
        "q": question
    }
    res = requests.get(
        "http://localhost:3000/api/v1/ai/gemini",
        params=params
    )
    data = res.json()
    if data.get("success"):
        print(data["data"]["response"])
    else:
        print("Error:", data.get("error"))

ask_gemini("Tell me a fun fact about space")