Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: IntenCheck Webhooks API
description: 'IntenCheck provides a comprehensive suite of Deep NLP text analysis endpoints that detect meta-programs, emotions, moods, and communication styles.
It supports multiple input and output languages natively.
## Quick Start
1. **Get your API Key** from the developer dashboard.
2. **Analyze Text** to get a psychological profile.
3. **Generate a Reply** using the analysis context to match or adjust styles.
## Authentication
All non-demo API endpoints require authentication via an API key. Pass it in your headers:
- `X-API-Key: YOUR_KEY`
- `Authorization: Bearer YOUR_KEY`
## Code Examples
**1. Analyze Text (Python / cURL)**
```bash
curl -X ''POST'' \
''https://intencheck.com/api/v1/analyze'' \
-H ''accept: application/json'' \
-H ''Authorization: Bearer YOUR_API_KEY'' \
-H ''Content-Type: application/json'' \
-d ''{
"text": "I am so frustrated that you never listen to my feedback!",
"features": ["emotions", "communication_style"],
"output_lang": "en"
}''
```
**2. Generate a Reply**
```bash
curl -X ''POST'' \
''https://intencheck.com/api/v1/reply'' \
-H ''accept: application/json'' \
-H ''Authorization: Bearer YOUR_API_KEY'' \
-H ''Content-Type: application/json'' \
-d ''{
"original_text": "I am so frustrated that you never listen to my feedback!",
"analysis_data": { ... result from /analyze ... },
"strategy": "de_escalate",
"mode": "constructive"
}''
```
## Common Error Codes
| Status | Description |
|--------|-------------|
| `400` | Bad Request: Invalid parameters or JSON schema. |
| `401` | Unauthorized: Missing or invalid API Key. |
| `402` | Payment Required: Insufficient prepaid balance. |
| `429` | Too Many Requests: Rate limit exceeded. |
| `500` | Internal Server Error / Upstream AI failure. |'
contact:
name: IntenCheck Developer Support
url: https://intencheck.com/
version: 1.1.0
tags:
- name: Webhooks
paths:
/api/v1/webhooks/stripe:
post:
summary: Stripe Webhook
description: Handles Stripe Webhook events.
operationId: stripe_webhook_api_v1_webhooks_stripe_post
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
tags:
- Webhooks
components:
securitySchemes:
OAuth2PasswordBearer:
type: oauth2
flows:
password:
scopes: {}
tokenUrl: /api/v1/auth/login