API Overview

Introduction

The Antinium API allows you to programmatically create, translate, and manage documents. Use it to integrate Antinium into your existing workflows, automate translations, and build custom applications.

Base URL

All API requests should be made to:

All endpoints use HTTPS and require authentication.

API Features

• Document Management: Create, read, update, and delete documents
• Translation: Translate documents and text segments
• Export: Export documents in various formats (PDF, DOCX, HTML)
• Workspace Management: Manage workspaces and members
• Webhooks: Receive notifications about document events

Request Format

All API requests use JSON format:

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Response Format

All API responses are in JSON format. Successful responses return a 200 status code:

{
  "success": true,
  "data": {
    // Response data
  }
}

Error responses return appropriate HTTP status codes (400, 401, 404, 500, etc.) with error details:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

Rate Limits

API rate limits depend on your plan:

• Pro: 1,000 requests per hour
• Ultra: 10,000 requests per hour
• Team: 5,000 requests per hour per seat
• Business: 20,000 requests per hour per seat

Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Getting Started

1. Get your API key from Settings → API Keys
2. Create a new API key (or use an existing one)
3. Copy the API key (you won't be able to see it again)
4. Include it in your API requests as a Bearer token
5. Start making API calls!

Example Request

Here's a simple example using cURL to translate text:

curl -X POST https://api.antinium.dev/v1/translate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Hello, world!",
    "source_language": "en",
    "target_language": "es"
  }'

SDKs and Libraries

While you can use the API directly with any HTTP client, we provide SDKs for popular languages:

• JavaScript/TypeScript: npm install @antinium/sdk
• Python: pip install antinium-sdk
• Ruby: gem install antinium-sdk
• Go: go get github.com/antinium/sdk-go

More SDKs are coming soon. Check our GitHub for updates.

Next Steps

• Authentication - Learn how to authenticate API requests
• Translation Endpoints - Translate documents via API
• Webhooks - Receive real-time notifications