API Reference

Complete REST API documentation with examples

Endpoints

POST/auth/sign-up

Sign Up

Create a new user account with email and password

Authentication

Authorization Header

Authorization: Bearer sk_prod_xxxxxxxxxxxxxxxx

Request Body

emailstring (required)
passwordstring (required, min 8 chars)
namestring (optional)
metadataobject (optional)

Response

userIdstring
emailstring
createdAtISO 8601 timestamp
verificationRequiredboolean

Examples

curl

curl
1curl -X POST https:600">//api.kynetra.io/v1/auth/sign-up \
2 -H 400">"Content-Type: application/json" \
3 -d '{
4 400">"email": 400">"user@example.com",
5 400">"password": 400">"securePassword123",
6 400">"name": 400">"John Doe"
7 }'

javascript

javascript
1400">"text-purple-400">class=400">"text-purple-400">const response = 400">"text-purple-400">class=400">"text-purple-400">await fetch(400">'https:600">//api.kynetra.io/v1/auth/sign-up', {
2 method: 400">'POST',
3 headers: { 400">'Content-Type': 400">'application/json' },
4 body: JSON.stringify({
5 email: 400">'user@example.com',
6 password: 400">'securePassword123',
7 name: 400">'John Doe'
8 })
9});
10400">"text-purple-400">class=400">"text-purple-400">const data = 400">"text-purple-400">class=400">"text-purple-400">await response.json();
Endpoint 1 of 5

Best Practices

Error Handling

  • Always check HTTP status codes
  • Implement exponential backoff for retries
  • Log errors for debugging
  • Handle rate limiting gracefully

Security

  • Never share API keys publicly
  • Use HTTPS for all requests
  • Rotate keys periodically
  • Restrict key permissions by scope

Performance

  • Use pagination for large datasets
  • Cache responses when possible
  • Implement request batching
  • Monitor API usage and limits

Integration

  • Test in staging first
  • Implement proper logging
  • Set up monitoring and alerts
  • Document your implementation

Rate Limiting

API requests are rate limited based on your subscription plan. Exceeding rate limits returns a 429 status code.

Free

Requests/sec

10

Requests/min

600

Pro

Requests/sec

100

Requests/min

6000

Enterprise

Requests/sec

Custom

Requests/min

Custom