Introducing the Partner API: Integrate Document Processing into Your Applications

We're excited to announce the launch of our new Partner API, enabling seamless integration of trans-form.ai's powerful document processing capabilities directly into your applications and workflows.

What is the Partner API?

The Partner API allows developers to programmatically upload documents, check processing status, and retrieve results—all without requiring users to interact with the trans-form.ai interface directly. This opens up new possibilities for automation and integration with your existing systems.

Key Features

• Document Upload: Send documents directly to trans-form.ai for processing from your applications
• Status Checking: Check the status of individual documents to track their progress through the processing pipeline
• Bulk Status Retrieval: Get the status of all documents in a project with a single API call
• Secure Authentication: API tokens with configurable scopes and expiration dates

Getting Started with the Partner API

Step 1: Enable the Partner API

Before you can use the Partner API, you need to enable it for your workspace:

1. Log in to your trans-form.ai account
2. Navigate to Workspace Settings
3. Go to the Partner API tab
4. Toggle the switch to enable the Partner API

Step 2: Create an API Token

Once the Partner API is enabled, you can create API tokens:

1. In the Partner API section of Workspace Settings, click Create Token
2. Enter a name for your token (e.g., "Production Integration")
3. Select the appropriate scopes (currently "Upload" is available)
4. Optionally set an expiration date
5. Click Create to generate your token

Important: The token will only be displayed once, so make sure to copy it and store it securely.

Step 3: Integrate with Your Application

With your API token in hand, you can now integrate the Partner API into your application. Here are the key endpoints:

Upload a Document

curl -X POST "https://api.trans-form.ai/partner-api/v1/upload" \
  -H "Authorization: Bearer YOUR_PARTNER_API_TOKEN" \
  -F "file=@/path/to/your/document.pdf" \
  -F "projectId=your-project-id"
  

Check Document Status

curl -X GET "https://api.trans-form.ai/partner-api/v1/document/DOCUMENT_ID/status" \
  -H "Authorization: Bearer YOUR_PARTNER_API_TOKEN"
  

List All Documents in a Project

curl -X GET "https://api.trans-form.ai/partner-api/v1/project/PROJECT_ID/documents" \
  -H "Authorization: Bearer YOUR_PARTNER_API_TOKEN"
  

Use Cases

The Partner API enables a wide range of integration scenarios:

• Automated Document Processing: Trigger document processing from your internal systems
• Custom Workflows: Build custom workflows that incorporate document processing
• White-labeled Solutions: Integrate trans-form.ai's capabilities into your own products
• Batch Processing: Process large batches of documents programmatically

Project-Specific Integration

Each project in trans-form.ai now includes API integration information. To access this:

1. Navigate to your project
2. Look for the "Partner API" section
3. You'll find project-specific cURL examples that you can copy and use directly

What's Next?

This is just the beginning of our API journey. We're planning to expand the Partner API with additional features:

• Webhooks for real-time notifications
• Additional authentication methods
• More granular permission scopes
• Direct access to extracted data

Have questions about the Partner API or need help with integration? Contact our support team for assistance.