name: linksquares-api description: "Integrates with the LinkSquares contract lifecycle management (CLM) API. Use when user mentions LinkSquares, contract management, agreements, Smart Values, contract metadata, or wants to retrieve, import, or manage contracts. Supports both Analyze API and Finalize API operations." license: Apache-2.0 compatibility: Requires curl or HTTP client, LINKSQUARES_API_KEY environment variable metadata: author: ak-skill version: "1.0.0" allowed-tools: Bash Read Write Edit WebFetch

LinkSquares API Integration

Interact with the LinkSquares contract lifecycle management platform to retrieve agreements, extract metadata, manage tasks, and import/export documents.

Overview

LinkSquares is an AI-powered CLM platform for managing contracts. This skill enables API interactions with two main products:

• Analyze API - Retrieve agreement metadata, Smart Values, terms, and documents
• Finalize API - Draft contracts, view updates, and manage templates

Setup

Authentication

LinkSquares uses API key authentication via the x-api-key header.

1. Get your API key from LinkSquares (requires Administrator access)
2. Set the environment variable:

export LINKSQUARES_API_KEY="your-api-key-here"

Base URL

All API requests use: https://api.linksquares.com

Instructions

Retrieve an Agreement

curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/agreements/{agreement_id}" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Accept: application/json"

Get Agreement Terms

curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/agreements/{agreement_id}/terms" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Accept: application/json"

Update a Term

curl -X PATCH \
  "https://api.linksquares.com/api/analyze/v2/agreements/{agreement_id}/terms/{term_id}" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": {"value": "new value"}}'

Download Agreement Document

curl -X GET \
  "https://api.linksquares.com/api/analyze/v2/agreements/{agreement_id}/download" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -o agreement.pdf

Extract Metadata (Smart Values)

curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/metadata" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Accept: application/json"

Import a Contract

curl -X POST \
  "https://api.linksquares.com/api/analyze/v1/import" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@contract.pdf" \
  -F "metadata={\"name\": \"Contract Name\", \"type\": \"NDA\"}"

Add Attachment to Agreement

curl -X POST \
  "https://api.linksquares.com/api/analyze/v1/agreements/{agreement_id}/attachments" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -F "file=@attachment.pdf"

Supported formats: CSV, DOC, DOCX, PDF, TXT, XLS, XLSX

Retrieve Tasks

curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/tasks" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Accept: application/json"

Update Task Status

curl -X PATCH \
  "https://api.linksquares.com/api/analyze/v1/tasks/{task_id}" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "approved"}'

Get Agreement Hierarchy

curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/hierarchy" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Accept: application/json"

Usage Examples

Example 1: Retrieve Contract Metadata

Input: "Get the metadata for agreement ID 12345 from LinkSquares"

Output: Executes API call to retrieve agreement details and Smart Values, returning JSON with contract name, type, parties, dates, and AI-extracted terms.

Example 2: Import a New Contract

Input: "Import the NDA document contract.pdf into LinkSquares"

Output: Uses the import endpoint to upload the PDF and create a new agreement with the specified metadata.

Example 3: Check Pending Tasks

Input: "Show me all pending contract tasks in LinkSquares"

Output: Retrieves the task list and formats it showing task IDs, descriptions, and statuses.

Guidelines

• Always verify LINKSQUARES_API_KEY is set before making requests
• Use v2 endpoints when available (more features)
• Handle rate limits with exponential backoff
• Validate agreement IDs before operations
• Check API response status codes for errors

Common Patterns

Batch Metadata Extraction

# Get all Smart Values, Terms, Types, and Tags
curl -X GET \
  "https://api.linksquares.com/api/analyze/v1/metadata?include=smart_values,terms,types,tags" \
  -H "x-api-key: $LINKSQUARES_API_KEY"

Update Agreement with Notes

curl -X PATCH \
  "https://api.linksquares.com/api/analyze/v1/agreements/{agreement_id}" \
  -H "x-api-key: $LINKSQUARES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"notes": "Updated via API", "tags": ["reviewed", "2024"]}'

Edge Cases

• Missing API Key: Check echo $LINKSQUARES_API_KEY and prompt user to set it
• Invalid Agreement ID: Returns 404 - verify ID exists before batch operations
• Rate Limiting: Implement retry with 2-4-8-16 second backoff
• Large Files: Import endpoint may have size limits - check documentation

References

• API_REFERENCE.md - Complete endpoint documentation
• scripts/ - Helper scripts for common operations
• LinkSquares Help Center

Limitations

• API key must be obtained from LinkSquares Administrator
• Rate limits are not publicly documented - contact LinkSquares support
• Some Finalize API features require additional licensing
• Webhook support is limited