Developers

API Documentation

Integrate ReadyIQ's prompt tools and marketplace into your own applications. All endpoints return JSON.

Base URL

https://readyiq.ai

Authentication

Pass your API token in the Authorization: Bearer {token} header. Generate tokens in your dashboard.

Endpoints

GET/api/vault

List public vault files. Supports filtering by type and pagination.

Parameters

typestringFilter by file type: prompt | agent | template
limitnumberMax results (default 50, max 100)
offsetnumberPagination offset (default 0)

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "displayName": "My Prompt",
      "fileType": "prompt",
      "starCount": 42,
      "authorUsername": "alice"
    }
  ]
}
GET/api/marketplace/explore

Browse public marketplace listings with optional type filter.

Parameters

typestringprompt | agent | template
limitnumberMax results (default 50)

Response

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "displayName": "GPT-4 Code Reviewer",
      "fileType": "prompt",
      "starCount": 198,
      "forkCount": 34,
      "authorUsername": "bob"
    }
  ]
}
GET/api/marketplace/leaderboard

Top contributors ranked by total stars across all published files.

Parameters

limitnumberMax results (default 20)

Response

{
  "success": true,
  "data": [
    {
      "username": "alice",
      "avatarUrl": "https://...",
      "totalStars": 1240,
      "fileCount": 18
    }
  ]
}
POST/api/tools/enhanceAuth required

Enhance a prompt using AI. Returns an improved version with explanations.

Request Body

{
  "prompt": "Summarize this document",
  "context": "Legal contract",
  "tone": "professional"
}

Response

{
  "success": true,
  "data": {
    "enhanced": "You are a legal analyst. Summarize the following contract in professional language, highlighting key obligations, deadlines, and risk clauses. Structure your response with: 1) Executive Summary 2) Key Terms 3) Risk Flags.",
    "improvements": [
      "Added role definition",
      "Structured output format",
      "Risk-focused scope"
    ]
  }
}
POST/api/tools/analyzeAuth required

Analyze a prompt for clarity, specificity, and effectiveness. Returns a score and feedback.

Request Body

{
  "prompt": "Write me a blog post about AI"
}

Response

{
  "success": true,
  "data": {
    "score": 42,
    "clarity": 3,
    "specificity": 2,
    "effectiveness": 3,
    "issues": [
      "No target audience defined",
      "Missing desired length or format",
      "No tone or style guidance"
    ],
    "suggestions": [
      "Specify target audience",
      "Define content structure",
      "Add word count target"
    ]
  }
}