[ Developers ]

Developer Documentation

REST API, webhook events, and SDK clients. Everything you need to integrate AI proficiency assessment into your workflow.

API Overview

Base URL

https://api.inpromptify.com/v1

All API requests use HTTPS. Authentication via Bearer token in the Authorization header.

Authentication

Authorization: Bearer sk_live_...

API keys are scoped to your organization. Generate keys from the dashboard under Settings.

Rate Limits

100 requests/minute for standard endpoints. Assessment creation is limited to your plan's credit allocation.

Key Endpoints

Method	Endpoint	Description
POST	/assessments	Create a new assessment
GET	/assessments/:id	Get assessment details and scores
GET	/assessments	List assessments (paginated)
GET	/org/analytics	Aggregate team analytics
POST	/webhooks	Register a webhook endpoint

Webhook Events

Configure webhook endpoints in your dashboard. All payloads are signed with HMAC-SHA256 for verification.

assessment.created

Fired when a new assessment is initiated for a candidate.

{
  "event": "assessment.created",
  "data": {
    "id": "asm_abc123",
    "orgId": "org_xyz",
    "candidateEmail": "candidate@example.com",
    "status": "PENDING",
    "createdAt": "2026-04-20T12:00:00Z"
  }
}

assessment.completed

Fired when a candidate finishes the assessment. Includes the full score breakdown.

{
  "event": "assessment.completed",
  "data": {
    "id": "asm_abc123",
    "score": 82,
    "dimensionScores": {
      "promptQuality": 85,
      "contextAwareness": 78,
      "iterationStrategy": 80,
      "outputEvaluation": 88,
      "toolOrchestration": 79
    },
    "completedAt": "2026-04-20T12:15:00Z"
  }
}

score.updated

Fired when a score is recalculated (e.g., after review or recalibration).

{
  "event": "score.updated",
  "data": {
    "id": "asm_abc123",
    "previousScore": 78,
    "score": 82,
    "updatedAt": "2026-04-20T14:00:00Z"
  }
}

Quickstart SDKs

Official client libraries for TypeScript and Python. Install and start making API calls in under a minute.

TypeScript

import { Inpromptify } from "@inpromptify/sdk";

const client = new Inpromptify({
  apiKey: process.env.INPROMPTIFY_API_KEY,
});

// Create an assessment
const assessment = await client.assessments.create({
  candidateEmail: "candidate@example.com",
  templateId: "default",
});

// Get results
const result = await client.assessments.get(assessment.id);
console.log(result.score);          // 82
console.log(result.dimensionScores); // { promptQuality: 85, ... }

Python

from inpromptify import Inpromptify

client = Inpromptify(api_key=os.environ["INPROMPTIFY_API_KEY"])

# Create an assessment
assessment = client.assessments.create(
    candidate_email="candidate@example.com",
    template_id="default",
)

# Get results
result = client.assessments.get(assessment.id)
print(result.score)            # 82
print(result.dimension_scores) # {"prompt_quality": 85, ...}

Postman Collection

Import our Postman collection to explore the API interactively. Includes pre-configured environments for sandbox and production.

Collection available after sign-up in your developer settings.