Utilities

Functions to support your AI Agents.


POSThttps://api.ailibrary.ai/v1/utilities/websearch

Searches the web for search terms

Request body

  • Name
    search_terms
    Type
    array
    Required
    required
    Description

    List of search terms

Request

POST
/v1/utilities/websearch
{
  "search_terms": ["artificial intelligence", "retireval augmented generation"]
}

Response

[
    {
        "term": "artificial intelligence",
        "prompt_context": "Artificial intelligence - WikipediaArtificial <b>intelligence</b> (AI), in its broadest sense, ...",
        "sources": [
            {
                "title": "Artificial intelligence - Wikipedia",
                "description": "Artificial <b>intelligence</b> (AI), in its broadest sense, is <b>intelligence</b> exhibited by machines, particularly computer systems. It is a field of research in computer science that develops and studies methods and software that enable machines to perceive their environment and use learning and <b>intelligence</b> to take actions that maximize their chances of achieving defined goals. [1]",
                "url": "https://en.wikipedia.org/wiki/Artificial_intelligence",
                "isFamilyFriendly": true,
                "language": "en",
                "full_text": "Artificial intelligence - WikipediaArtificial <b>intelligence</b> (AI), in its broadest sense, is <b>intelligence</b> exhibited by machines, particularly computer systems. It is a field of research in computer science that develops and studies methods and software that enable machines to perceive their environment and use learning and <b>intelligence</b> to take actions that maximize their chances of achieving defined goals. [1]"
            },
            // ... more sources
        ]
    },
    {
        "term": "retireval augmented generation",
        "prompt_context": "What is Retrieval-Augmented Generation (RAG) - GeeksforGeeks<b>Retrieval</b>-<b>augmented</b>...",
        "sources": [
            {
                "title": "What is Retrieval-Augmented Generation (RAG) - GeeksforGeeks",
                "description": "<b>Retrieval</b>-<b>augmented</b> <b>generation</b> (RAG) is an innovative approach in the field of natural language processing (NLP) that combines the strengths of <b>retrieval</b>-based and <b>generation</b>-based models to enhance the quality of generated text. This hybrid model aims to leverage the vast amounts of information available in large-scale databases or knowledge bases, making it particularly effective for tasks that require accurate and contextually relevant information. ...",
                "url": "https://www.geeksforgeeks.org/what-is-retrieval-augmented-generation-rag/",
                "isFamilyFriendly": true,
                "language": "en",
                "full_text": "What is Retrieval-Augmented Generation (RAG) - GeeksforGeeks<b>Retrieval</b>-<b>augmented</b> <b>generation</b> (RAG) is an innovative approach in the field of natural language processing (NLP) that combines the strengths of <b>retrieval</b>-based and <b>generation</b>-based models to enhance the quality of generated text. This hybrid model aims to leverage the vast amounts of information available in large-scale databases or knowledge bases, making it particularly effective for tasks that require accurate and contextually relevant information. ..."
            },
            // ... more sources
        ]
    }
]

POSThttps://api.ailibrary.ai/v1/utilities/news

Searches the web for news articles

Request body

  • Name
    search_terms
    Type
    array
    Required
    required
    Description

    List of search terms

Request

POST
/v1/utilities/news
{
  "search_terms": ["artificial intelligence", "retireval augmented generation"]
}

Response

[
    {
      "search_term": "artificial intelligence",
      "prompt_context": "...",
      "sources": [
        {
            "title": "<b>AI agents</b> spark ...",
            "description": "AI agents continue to ...",
            "url": "https://www....",
            "datePublished": "2025-02-10T22:18:00.0000000Z",
            "provider": "Biometric Companies",
            "full_text": "<b>AI agents</b> spark ..."
        },
        // ... more sources
      ]
    },
    {
      "search_term": "retireval augmented generation",
      "prompt_context": "...",
      "sources": [
        {
            "title": "<b>RAG</b> continue ...",
            "description": "Taking the world by storm, AI Library ...",
            "url": "https://www....",
            "datePublished": "2025-02-10T22:18:00.0000000Z",
            "provider": "MSNBC",
            "full_text": "<b>RAG</b> continues ..."
        },
        // ... more sources
      ]
    }
]

POSThttps://api.ailibrary.ai/v1/utilities/webparser

Web Parser

Parses a web page for content and returns related links and content

Request body

  • Name
    urls
    Type
    array
    Required
    required
    Description

    List of urls

Request

POST
/v1/utilities/webparser
{
  "urls": ["https://portlandgeneral.com/about/info/rates-and-regulatory/tariff"]
}

Response

[
    {
        "url": "https://www.ailibrary.ai",
        "title": "AI Library Agent Builder Platform",
        "domain": "https://www.ailibrary.ai",
        "body": "AI LibraryAI LibraryOpen main menuAgentsUse CasesPricingBUILD YOUR AGENTLog in →Generative AI Platform to rapidly build ...",
        "relatedurls": [
            {
                "url": "https://www.ailibrary.ai/blog",
                "title": "AI Library Status",
                "description": "Welcome to AI Library's home for real-time and historical data on system performance.",
                "type": "web"
            },
            {
                "url": "https://www.ailibrary.ai/about",
                "title": "AI Library · GitHub",
                "description": "AI Library enables faster generative AI adoption in enterprises - AI Library",
                "type": "web"
            },
            // ... more related urls
        ]
    },
    // ... more page objects
]

POSThttps://api.ailibrary.ai/v1/utilities/docparser

Document Parser

Parses a document for content

Request body

  • Name
    urls
    Type
    array
    Required
    required
    Description

    List of urls

Request

POST
/v1/utilities/docparser
{
  "urls": [
    "https://domain.com/mydoc1.pdf", 
    ///...
  ]
}

Response

[
    {
        "url": "https://domain.com/mydoc1.pdf",
        "title": "mydoc1.pdf",
        "body": "lorem ipsum dolor...",
    },
    ///...
]

POSThttps://api.ailibrary.ai/v1/utilities/thumbnail

Document Thumbnail

Generates a thumbnail for a document

Request body

  • Name
    urls
    Type
    array
    Required
    required
    Description

    List of urls

Request

POST
/v1/utilities/thumbnail
{
  "urls": [
    "https://domain.com/mydoc1.pdf", 
    ///...
  ]
}

Response

[
  {
      "url": "https://domain.com/mydoc1.pdf",
      "thumbnail": "https://myfilestorage.com/mydoc1.jpg"
  },
///...

]

POSThttps://api.ailibrary.ai/v1/utilities/schema_generator

JSON Schema Generator

Generates a JSON schema for forms.

Request body

  • Name
    content
    Type
    string
    Required
    required
    Description

    Phrase explaining the schema.

Request

POST
/v1/utilities/schema_generator
{
    "content": "Please generate a form with the following fields: \n name (string), email(string), phone(number), experience in years (number), ai experience in years (number), highest educational qualification (phd, bachelor's degree, high school, not mentioned)"
}

Response

{
    "name": {
        "order": 1,
        "description": "What's the name?",
        "type": "string"
    },
    "email": {
        "order": 2,
        "description": "What's the email?",
        "type": "string"
    },
    "phone": {
        "order": 3,
        "description": "What's the phone number?",
        "type": "number"
    },
    "experience_in_years": {
        "order": 4,
        "description": "How many years of experience does the candidate have?",
        "type": "number"
    },
    "ai_experience_in_years": {
        "order": 5,
        "description": "How many years of experience with AI does the candidate have?",
        "type": "number"
    },
    "highest_educational_qualification": {
        "order": 6,
        "type": "string",
        "enum": [
            "",
            "PhD",
            "Bachelor's Degree",
            "High School",
            "Not Mentioned"
        ]
    }
}

Was this page helpful?