Company Descriptions Generator

This tutorial will show you how to build a company description generator that takes a company name and country as input and returns comprehensive information about the company using the Linkup API’s structured output feature.

What we’re building

Our company description generator will:

Take a company name and country as input
Use Linkup API to search for information about the company
Return structured data about the company (description, industry, size, location, etc.)

Building the generator

Define the Schema

Before we start coding, let’s define the schema that specifies what information we want to extract about companies. This schema will be used throughout our implementation:

COMPANY_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The official name of the company"
        },
        "description": {
            "type": "string",
            "description": "A comprehensive description of what the company does"
        },
        "location": {
            "type": "string",
            "description": "Location of company headquarters"
        },
        "companySize": {
            "type": "string",
            "description": "Approximate number of employees"
        },
        "linkedInUrl": {
            "type": "string",
            "description": "Company's LinkedIn profile URL"
        }
    },
    "required": ["name", "description"]
}

const COMPANY_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The official name of the company"
        },
        "description": {
            "type": "string",
            "description": "A comprehensive description of what the company does"
        },
        "location": {
            "type": "string",
            "description": "Location of company headquarters"
        },
        "companySize": {
            "type": "string",
            "description": "Approximate number of employees"
        },
        "linkedInUrl": {
            "type": "string",
            "description": "Company's LinkedIn profile URL"
        }
    },
    "required": ["name", "description"]
};

This schema defines all the fields we want to extract about a company. The required fields are name, description, and industry, while the rest are optional but provide valuable additional information.

Install the SDK

Next, let’s install the Linkup SDK in your preferred language:

pip install linkup-sdk

npm i linkup-sdk

Set Up the Client

Initialize the Linkup client with your API key:

Get your API key

Create a Linkup account for free to get your API key.

from linkup import LinkupClient

client = LinkupClient(api_key="<YOUR_LINKUP_API_KEY>")

import { LinkupClient } from 'linkup-sdk';

const client = new LinkupClient({
  apiKey: '<YOUR_LINKUP_API_KEY>',
});

Create the Query Generator

Create a function to generate the search query:

def generate_query(company_name: str, country: str) -> str:
    query = (
            f"Find detailed information about {company_name} in {country}. "
            "Include their main products/services, industry focus, company size, "
            "and any notable achievements or recent news. Also find their "
            "LinkedIn company page if available."
        )
    return query

function generateQuery(companyName: string, country: string) {
    let query;

    query = (
            `Find detailed information about ${companyName} in ${country}. ` +
            "Include their main products/services, industry focus, company size, " +
            "and any notable achievements or recent news. Also find their " +
            "LinkedIn company page if available."
        );

    return query;
}

Complete Implementation

Here’s the complete implementation that puts everything together:

from linkup import LinkupClient
import json
from typing import Dict, Any
from pprint import pprint

# Schema definition (from Step 1)
COMPANY_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The official name of the company"
        },
        "description": {
            "type": "string",
            "description": "A comprehensive description of what the company does"
        },
        "location": {
            "type": "string",
            "description": "Location of company headquarters"
        },
        "companySize": {
            "type": "string",
            "description": "Approximate number of employees"
        },
        "linkedInUrl": {
            "type": "string",
            "description": "Company's LinkedIn profile URL"
        }
    },
    "required": ["name", "description"]
}

# Initialize the client
client = LinkupClient(api_key="<YOUR_LINKUP_API_KEY>")

# Query generator (from Step 4)
def generate_query(company_name: str, country: str) -> str:
    query = (
            f"Find detailed information about {company_name} in {country}. "
            "Include their main products/services, industry focus, company size, "
            "and any notable achievements or recent news. Also find their "
            "LinkedIn company page if available."
        )
    return query

def generate_company_description(company_name: str, country: str) -> Dict[str, Any]:
    """
    Generate a structured description of a company using its name, country.

    Args:
        company_name: Name of the company
        country: Country where the company operates

    Returns:
        Dictionary containing structured company information
    """
    try:
        # Clean input
        company_name = company_name.strip()
        country = country.strip()

        # Generate search query using the function from Step 4
        query = generate_query(company_name, country)

        # Call Linkup API
        response = client.search(
            query=query,
            depth="deep",  # Use deep for more thorough results
            output_type="structured",
            structured_output_schema=json.dumps(COMPANY_SCHEMA)
        )

        return response

    except Exception as e:
        return {
            "error": str(e),
            "company_name": company_name,
            "country": country
        }

# Example usage
if __name__ == "__main__":
    # Example companies
    companies = [
        ("Anthropic", "United States"),
        ("Stripe", "United States"),
        ("OpenAI", "United States")
    ]

    for company_name, country in companies:
        print(f"\nLooking up: {company_name} in {country}")
        result = generate_company_description(company_name, country)
        pprint(result)

import { LinkupClient } from 'linkup-sdk';

// Schema definition (from Step 1)
const COMPANY_SCHEMA = {
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "The official name of the company"
        },
        "description": {
            "type": "string",
            "description": "A comprehensive description of what the company does"
        },
        "location": {
            "type": "string",
            "description": "Location of company headquarters"
        },
        "companySize": {
            "type": "string",
            "description": "Approximate number of employees"
        },
        "linkedInUrl": {
            "type": "string",
            "description": "Company's LinkedIn profile URL"
        }
    },
    "required": ["name", "description"]
};

// Initialize the client
const client = new LinkupClient({
    apiKey: '<YOUR_LINKUP_API_KEY>',
});

// Query generator (from Step 4)
function generateQuery(companyName: string, country: string) {
    let query;
    query = (
            `Find detailed information about ${companyName} in ${country}. ` +
            "Include their main products/services, industry focus, company size, " +
            "and any notable achievements or recent news. Also find their " +
            "LinkedIn company page if available."
        );
    return query;
}

async function generateCompanyDescription(companyName: string, country: string) {
    try {
        // Clean input
        companyName = companyName.trim();
        country = country.trim();

        // Generate search query using the function from Step 4
        const query = generateQuery(companyName, country);

        // Call Linkup API
        const response = await client.search({
            query: query,
            depth: "deep",  // Use deep for more thorough results
            outputType: "structured",
            structuredOutputSchema: COMPANY_SCHEMA
        });

        return response;

    } catch (error: any) {
        return {
            error: error.message,
            companyName: companyName,
            country: country
        };
    }
}

// Example usage
async function main() {
    // Example companies
    const companies = [
        ["Anthropic", "United States"],
        ["Stripe", "United States"],
        ["OpenAI", "United States"]
    ];

    for await (const [companyName, country] of companies) {
        console.log(`\nLooking up: ${companyName} in ${country}`);
        const result = await generateCompanyDescription(companyName, country);
        console.log(JSON.stringify(result, null, 2));
    }
}

main().catch(console.error);

How it works

The company description generator works in three main steps:

Input processing: the tool takes a company name and country as input and cleans them.
Query generation: it creates a search query that includes both the company name and country to improve search accuracy.
Structured output: uses Linkup’s structured output feature with a comprehensive schema to ensure consistent, well-formatted results.

Possible enhancements

For a production version, consider adding:

Add as much information you have about companies in the queries, to limit ambiguity about which company you are searching for.
Implement rate limiting and error handling for API usage.
Batch processing to search for multiple companies in parallel if you are enriching a dataset for example.

Need help? Email support@linkup.so, ping us on Discord, or talk to us.

Get Started

Endpoints

Platform

Guides

Tutorials

FAQ

What we’re building

Building the generator

Get your API key

How it works

Possible enhancements

​What we’re building

​Building the generator

Get your API key

​How it works

​Possible enhancements

What we’re building

Building the generator

How it works

Possible enhancements