v1

OpenAPI 3.1.02026-08-0458114534.0 KB

Contents

post/contents

Request body

OR

Example request

{
  "text": {
    "maxCharacters": 1000,
    "verbosity": "standard",
    "includeSections": [
      "body",
      "header"
    ],
    "excludeSections": [
      "navigation",
      "footer",
      "sidebar"
    ]
  },
  "highlights": {
    "query": "Key advancements",
    "maxCharacters": 2000,
    "numSentences": 1,
    "highlightsPerUrl": 1
  },
  "summary": {
    "query": "Main developments",
    "schema": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "title": "Title",
      "type": "object",
      "properties": {
        "Property 1": {
          "type": "string",
          "description": "Description"
        },
        "Property 2": {
          "type": "string",
          "enum": [
            "option 1",
            "option 2",
            "option 3"
          ],
          "description": "Description"
        }
      },
      "required": [
        "Property 1"
      ]
    }
  },
  "extras": {
    "links": 1,
    "imageLinks": 1
  },
  "context": true,
  "livecrawl": "preferred",
  "livecrawlTimeout": 1000,
  "maxAgeHours": 24,
  "subpages": 1
}

Response

OK

requestIdstring

Unique identifier for the request.

contextstring

Deprecated. Combined context string from search results. Use highlights or text instead.

Example response

{
  "requestId": "b5947044c4b78efa9552a7c89b306d95",
  "results": [
    {
      "title": "A Comprehensive Overview of Large Language Models",
      "url": "https://arxiv.org/pdf/2307.06435.pdf",
      "publishedDate": "2023-11-16T01:36:32.547Z",
      "author": "Humza Naveed",
      "id": "https://arxiv.org/abs/2307.06435",
      "image": "https://arxiv.org/pdf/2307.06435.pdf/page_1.png",
      "favicon": "https://arxiv.org/favicon.ico",
      "text": "Abstract Large Language Models (LLMs) have recently demonstrated remarkable capabilities...",
      "highlights": [
        "Such requirements have limited their adoption..."
      ],
      "highlightScores": [
        0.4600165784358978
      ],
      "summary": "This overview paper on Large Language Models (LLMs) highlights key developments...",
      "subpages": [
        {
          "title": "A Comprehensive Overview of Large Language Models",
          "url": "https://arxiv.org/pdf/2307.06435.pdf",
          "publishedDate": "2023-11-16T01:36:32.547Z",
          "author": "Humza Naveed",
          "id": "https://arxiv.org/abs/2307.06435",
          "image": "https://arxiv.org/pdf/2307.06435.pdf/page_1.png",
          "favicon": "https://arxiv.org/favicon.ico"
        }
      ],
      "extras": {
        "links": []
      }
    }
  ],
  "statuses": [
    {
      "id": "https://example.com",
      "status": "success",
      "error": {
        "tag": "CRAWL_NOT_FOUND",
        "httpStatusCode": 404
      }
    }
  ],
  "costDollars": {
    "total": 0.007,
    "search": {
      "neural": 0.007
    }
  }
}