Overview

The Blackwire API provides programmatic access to our cutting-edge cybersecurity platform, allowing you to leverage AI-powered threat detection and response capabilities in your own applications.

For detailed, up-to-date API specifications, please refer to our Swagger OpenAPI documentation.

API Categories

Our API is organized into the following main categories:

1. AI

   • Conversation management

   • AI-powered analysis

2. Lexi AI

   • Predictive prompts

   • Summarization

   • Entity extraction

3. Registry

   • Item management (create, read, update, delete)

4. Session

   • Session management with conversation support

5. Trending

   • Trending items management

Authentication

API access requires authentication using an API key (client ID and secret). You can obtain these credentials from the Blackwire application:

1. Log in to app.blackwire.ai

2. Navigate to User Profile -> Edit Profile -> Personal Tokens

Getting Started

To start using the Blackwire API, please refer to our GitHub repository for the latest test script, setup instructions, and usage examples.

The repository provides a comprehensive test suite that covers various endpoints of the Blackwire API, including conversation management, AI-powered analysis, and data operations.

API Usage Examples

For detailed usage examples and a test script, please visit our GitHub repository. The test script provides comprehensive examples of how to interact with various Blackwire API endpoints.

Rate Limiting and Usage Guidelines

At Blackwire, we strive to provide a robust and responsive API service to all our users. While we currently do not impose strict rate limits, we expect all API consumers to use the service responsibly and efficiently.

Responsible Usage

1. Efficient Querying: Design your applications to make efficient use of the API, minimizing unnecessary calls.

2. Caching: Implement appropriate caching mechanisms to reduce redundant requests for frequently accessed data.

3. Batch Processing: Where possible, use batch operations instead of multiple individual requests.

4. Error Handling: Implement proper error handling in your applications, including backing off when receiving error responses.

Fair Use Policy

Blackwire reserves the right to limit or suspend API access for accounts that we determine, at our sole discretion, are negatively impacting the performance and security of our service. This may include, but is not limited to:

1. Excessive request volumes

2. Patterns indicative of abuse or automated scraping

3. Any usage that violates our Terms of Service

Monitoring and Adjustments

We continuously monitor API usage patterns to ensure optimal performance for all users. Based on these observations:

1. We may contact you to discuss your usage patterns and suggest optimizations.

2. In cases of suspected abuse or unintended high-volume usage, we may temporarily limit access to protect our systems.

3. We reserve the right to implement or modify rate limits as needed to maintain service quality for all users.

Communication

If we need to take any action regarding your API usage, we will make every effort to communicate with you promptly. We are committed to working with our users to ensure both your needs and the overall system integrity are maintained.

For any questions about API usage or to discuss high-volume use cases, please contact our support team at support@blackwirelabs.com.