Installation

Install the Respectify SDK for your language and set up authentication.

Installation

TypeScript

npm install @respectify/client

Or with yarn:

yarn add @respectify/client

Requirements: Node.js 18+

Python

pip install respectify

Or with uv:

uv add respectify

Requirements: Python 3.9+

PHP

composer require respectify/respectify-php

Requirements: PHP 7.4+, ReactPHP

REST API

No installation needed. Use any HTTP client (curl, httpx, Guzzle, etc.)

Getting Your API Key

1. Sign up at respectify.ai
2. Go to your API Keys in the dashboard
3. Create a new API key

Security

Treat your API key like a password. Never hardcode it in source code. Use environment variables or a secrets manager.

Client Setup

TypeScript

import { RespectifyClient } from "@respectify/client";

const client = new RespectifyClient({
  email: process.env.RESPECTIFY_EMAIL!,
  apiKey: process.env.RESPECTIFY_API_KEY!,
});

All methods are async and return promises.

Python

Network calls take time. The async client lets your code do other things while waiting, via other coroutines. The blocking client is simpler for straightforward code where parallel requests, or waiting for network responses, isn't an issue. If you're unsure, start with the blocking client.

Blocking Client

import os
from respectify import RespectifyClient

client = RespectifyClient(
    email=os.environ['RESPECTIFY_EMAIL'],
    api_key=os.environ['RESPECTIFY_API_KEY']
)

Async Client

import os
from respectify import RespectifyAsyncClient

client = RespectifyAsyncClient(
    email=os.environ['RESPECTIFY_EMAIL'],
    api_key=os.environ['RESPECTIFY_API_KEY']
)

PHP

The PHP client is async, built on ReactPHP. API calls return promises; call $client->run() to execute the event loop.

use Respectify\RespectifyClientAsync;

$client = new RespectifyClientAsync(
    getenv('RESPECTIFY_EMAIL'),
    getenv('RESPECTIFY_API_KEY')
);

REST API

Include these headers in every request:

curl -X POST https://app.respectify.ai/v0.2/commentscore \
  -H "X-User-Email: your@email.com" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"comment": "...", "article_context_id": "..."}'

Verifying Credentials

Test that your credentials work and check that your account has balance. This call is free. active is true when your balance is above $0, and plan_name reports the balance:

TypeScript

const result = await client.checkUserCredentials();
console.log(`Active: ${result.active}`);
console.log(`Status: ${result.status}`);
console.log(result.plan_name); // e.g. "Credit Balance: $12.34"

Python

Blocking Client

result = client.check_user_credentials()
print(f"Active: {result.active}")
print(f"Status: {result.status}")
print(result.plan_name)  # e.g. "Credit Balance: $12.34"

Async Client

result = await client.check_user_credentials()
print(f"Active: {result.active}")
print(f"Status: {result.status}")
print(result.plan_name)  # e.g. "Credit Balance: $12.34"

PHP

$client->checkUserCredentials()
    ->then(function ($result) {
        echo "Active: " . ($result['active'] ? 'Yes' : 'No') . "\n";
        echo $result['plan_name'] . "\n"; // e.g. "Credit Balance: $12.34"
    });

$client->run();

REST API

curl -X GET https://app.respectify.ai/v0.2/usercheck \
  -H "X-User-Email: your@email.com" \
  -H "X-API-Key: your-api-key-here"

Response:

{
  "active": true,
  "status": "active",
  "expires": null,
  "plan_name": "Credit Balance: $12.34",
  "allowed_endpoints": null,
  "error": null
}