API Tools Overview

Introduction to API integration capabilities

Last updated 4 months ago

API Tools in Whisperit enable you to connect your legal workspace with external services and automate workflows. This guide introduces the API Tools feature and how to create custom integrations for your practice.

What are API Tools?

API Tools allow you to create custom integrations between Whisperit and other systems. With API Tools, you can:

  • Connect to practice management systems

  • Integrate with document storage services

  • Automate data synchronization

  • Extend Whisperit's capabilities

  • Create custom workflows for your firm

  • Pull data from external legal databases

Accessing API Tools

To access API Tools:

  1. Navigate to Workspace in the left sidebar

  2. Click on API Tools

  3. View your existing API integrations or create new ones

You'll see a list of your configured API tools or a message indicating no tools are configured yet.

Creating a New API Tool

Step-by-step setup

  1. Click the "New API Tool" button

  2. Enter a Tool Name that describes the integration

  3. Add a Description explaining what the API does

  4. Configure LLM Instructions (optional) to guide how the AI uses this tool

  5. Select the HTTP Method (GET, POST, PUT, DELETE, etc.)

  6. Enter the Base URL for the API endpoint

  7. Configure Authentication Type if required

  8. Add Custom Headers if needed

  9. Set up Query Parameters for dynamic data

  10. Review the Request Preview

  11. Save your API tool

HTTP Methods

Choose the appropriate HTTP method for your integration:

GET - Retrieve data from an external service Use GET requests to fetch information from practice management systems, legal databases, or document repositories.

POST - Send data to an external service Use POST requests to create new records, submit forms, or trigger actions in other systems.

PUT - Update existing data Use PUT requests to modify records in external systems.

DELETHE - Remove data Use DELETE requests to remove records from external systems.

Authentication Options

API Tools supports various authentication methods:

None - For public APIs that don't require authentication

API Key - For services that use API key authentication Add your API key in the authentication configuration.

Bearer Token - For OAuth and token-based authentication Configure bearer token authentication for secure API access.

Basic Auth - For username/password authentication Provide credentials for basic HTTP authentication.

Configuring Custom Headers

Custom headers allow you to send additional information with API requests:

  • Content-Type headers for specifying data formats

  • Custom authentication headers

  • Request tracking headers

  • API version headers

Setting Up Query Parameters

Query parameters enable dynamic data in your API requests:

  • Filter results based on case information

  • Pass user-specific data to external systems

  • Include timestamps or date ranges

  • Customize API responses based on context

Best Practices for API Tools

Test thoroughly before deployment Test your API integrations in a controlled environment before using them in production workflows.

Use descriptive names Name your API tools clearly so team members understand their purpose. Examples:

  • "DocuSign - Send Contract for Signature"

  • "Clio - Fetch Client Information"

  • "NetDocuments - Upload Discovery Files"

Document your integrations Maintain documentation of what each API tool does, including:

  • Purpose and use cases

  • Required parameters

  • Expected responses

  • Error handling

Secure your credentials Protect API keys and authentication tokens:

  • Never share API credentials in documents

  • Rotate keys periodically

  • Use the minimum required permissions

  • Monitor API usage for unusual activity

Monitor API usage Track your API integrations to ensure:

  • They're functioning correctly

  • Response times are acceptable

  • Error rates are low

  • Usage stays within API limits

Common Use Cases

Practice management integration Connect Whisperit to your practice management system to:

  • Fetch client information automatically

  • Update matter status

  • Sync time entries

  • Pull case details

Document storage sync Integrate with document management systems to:

  • Upload generated documents

  • Retrieve templates

  • Organize files automatically

  • Maintain version control

Legal research databases Connect to legal research platforms to:

  • Search case law

  • Retrieve statutes

  • Access legal commentary

  • Pull citation information

E-signature services Integrate with e-signature platforms to:

  • Send documents for signature

  • Track signing status

  • Retrieve executed documents

  • Manage signature workflows

Troubleshooting API Tools

If your API tool isn't working

  • Verify the Base URL is correct

  • Check authentication credentials

  • Ensure HTTP method is appropriate

  • Review custom headers and parameters

  • Check the Request Preview for errors

If you receive authentication errors

  • Confirm API key or token is valid

  • Check if credentials need to be refreshed

  • Verify authentication type matches the API requirements

  • Review custom headers for auth issues

If responses are unexpected

  • Review the API documentation

  • Check query parameters are correctly formatted

  • Verify the HTTP method is appropriate

  • Test the API endpoint independently

Security Considerations

Protect sensitive data API Tools can access sensitive information. Ensure:

  • Only authorized users can create API tools

  • Credentials are securely stored

  • Data transmitted is encrypted

  • API access follows your security policies

Comply with data protection regulations When integrating external services:

  • Verify third-party compliance with legal industry regulations

  • Ensure data processing agreements are in place

  • Review data retention policies

  • Document data flows for compliance audits