Upload content in bulk, including metadata, with our Ingestion API
The Enterprise Sync feature offers a streamlined solution utilizing API technology to simplify the process of uploading internal content in bulk for customers, including metadata. Users can also upload attachments and share documents. After uploading, the platform provides easy access through search features, enabling users to swiftly locate content using filters and keywords.
- Who is Enterprise Sync Suited for?
- Initiating the API Key Request Process
- Upload Actions
- Items to Note
- Monitoring Added Documents
- Reconciling Added Documents
- Searching Across Content
Who is Enterprise Sync Suited for?
The API key distribution process is tailored for organizations that require secure and efficient access to either our Software as a Service (SaaS) or Private Cloud applications. This process is particularly suited for:
- Businesses and Organizations seeking to integrate our services into their existing workflows or applications, requiring direct API access for functionality such as data retrieval, content upload, or system integration.
- Developers and IT Departments within these organizations who need to automate interactions with our platform, streamline content management, or develop custom solutions that leverage our services.
- Compliance and Security-Conscious Entities that prioritize the security of their data and systems. Our manual review process ensures that API access is granted in a controlled manner, aligning with best practices for data security and compliance.
- Innovators and Solution Providers looking to create value-added services or enhancements around our platform, requiring programmatic access to extend the capabilities of our SaaS or Private Cloud offerings.
Initiating the API Key Request Process
- Submit Your Request: Reach out through the designated channel (such as email or a contact form), providing the organization's name and a valid email address for communication.
- Review Process: Our team will review the request against our usage policies and terms of service to ensure alignment.
- Key Issuance: Upon approval, we will issue the API key, sending it to the provided email along with necessary instructions and documentation.
This process ensures a secure, efficient, and compliant way to access and utilize our services, maintaining the highest standards of service and security for all users. For further information or assistance, contact our support team.
Upload Actions
Metadata Customization:
- Users can add and remove Tags & Tickers as metadata during the ingestion process.
Items to Note
Attachment Limits:
- A maximum of 10 attachments is allowed per parent document.
Attachment Modifications:
- Attachments cannot be updated or edited post-ingestion.
Sharing Options:
- Custom sharing is enabled using an External ID for precise control over document access.
Rate Limit:
- The API enforces a rate limit of 50 Requests Per Minute (RPM) to ensure equitable access and system stability.
File Size Limit:
- The maximum file size allowed is 150 MB per document, accommodating a wide range of content sizes.
Supported File Types:
- The Ingestion API accepts documents in specific formats: .pdf, .html, .htm, .txt, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .msg, .eml, .csv, .xlsb, .xlsm, .one, .tsv, .ods, ensuring compatibility and processing efficiency.
Filename Restrictions:
- Filenames must not contain any slash ("/" or "") characters, ensuring compatibility with file systems. Only one dot (.) is allowed in filenames, preventing confusion with double extensions (e.g., "file.php.txt"). The maximum character length for filenames is 255 characters, supporting descriptive naming while ensuring system compatibility.
Monitoring Added Documents
AlphaSense integration monitoring tracks the progress and details of integrations in real time to ensure everything is on course for optimal ingestion. Click into Monitoring to get a central view of documents details and status.
Reconciling Added Documents
AlphaSense integration reporting equips you with the tools for better understanding, management and optimization of your uploads. Click into Reports to get an audit of all content added with the ability to download the report.
Searching Across Content
The documents you add are processed through our AI algorithms and are made available almost immediately in platform. AlphaSense’s AI will automatically tag your documents and you will be able to search across internal content and apply AlphaSense’s AI search & discovery tools to a discrete set of documents for project-based work.
To quickly search across all of your internal content:
- Click the Company Integrations dropdown in the vertical filters
To search across uploaded documents only:
- Hover over Enterprise Sync, then click Only
Click here to review our data security, data architecture, software, and more.
For more information about how to get started and content limitations please refer to our Developer Portal FAQs.