kgsearch-api.json

{
  "basePath": "",
  "baseUrl": "https://kgsearch.googleapis.com/",
  "batchPath": "batch",
  "description": "Searches the Google Knowledge Graph for entities.",
  "discoveryVersion": "v1",
  "documentationLink": "https://developers.google.com/knowledge-graph/",
  "icons": {
    "x16": "http://www.google.com/images/icons/product/search-16.gif",
    "x32": "http://www.google.com/images/icons/product/search-32.gif"
  },
  "id": "kgsearch:v1",
  "kind": "discovery#restDescription",
  "name": "kgsearch",
  "ownerDomain": "google.com",
  "ownerName": "Google",
  "parameters": {
    "$.xgafv": {
      "description": "V1 error format.",
      "enum": [
        "1",
        "2"
      ],
      "enumDescriptions": [
        "v1 error format",
        "v2 error format"
      ],
      "location": "query",
      "type": "string"
    },
    "access_token": {
      "description": "OAuth access token.",
      "location": "query",
      "type": "string"
    },
    "alt": {
      "default": "json",
      "description": "Data format for response.",
      "enum": [
        "json",
        "media",
        "proto"
      ],
      "enumDescriptions": [
        "Responses with Content-Type of application/json",
        "Media download with context-dependent Content-Type",
        "Responses with Content-Type of application/x-protobuf"
      ],
      "location": "query",
      "type": "string"
    },
    "callback": {
      "description": "JSONP",
      "location": "query",
      "type": "string"
    },
    "fields": {
      "description": "Selector specifying which fields to include in a partial response.",
      "location": "query",
      "type": "string"
    },
    "key": {
      "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
      "location": "query",
      "type": "string"
    },
    "oauth_token": {
      "description": "OAuth 2.0 token for the current user.",
      "location": "query",
      "type": "string"
    },
    "prettyPrint": {
      "default": "true",
      "description": "Returns response with indentations and line breaks.",
      "location": "query",
      "type": "boolean"
    },
    "quotaUser": {
      "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
      "location": "query",
      "type": "string"
    },
    "uploadType": {
      "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
      "location": "query",
      "type": "string"
    },
    "upload_protocol": {
      "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
      "location": "query",
      "type": "string"
    }
  },
  "protocol": "rest",
  "resources": {
    "entities": {
      "methods": {
        "search": {
          "description": "Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org",
          "flatPath": "v1/entities:search",
          "httpMethod": "GET",
          "id": "kgsearch.entities.search",
          "parameterOrder": [],
          "parameters": {
            "ids": {
              "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A\u0026ids=B",
              "location": "query",
              "repeated": true,
              "type": "string"
            },
            "indent": {
              "description": "Enables indenting of json results.",
              "location": "query",
              "type": "boolean"
            },
            "languages": {
              "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
              "location": "query",
              "repeated": true,
              "type": "string"
            },
            "limit": {
              "description": "Limits the number of entities to be returned.",
              "format": "int32",
              "location": "query",
              "type": "integer"
            },
            "prefix": {
              "description": "Enables prefix match against names and aliases of entities",
              "location": "query",
              "type": "boolean"
            },
            "query": {
              "description": "The literal query string for search.",
              "location": "query",
              "type": "string"
            },
            "types": {
              "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
              "location": "query",
              "repeated": true,
              "type": "string"
            }
          },
          "path": "v1/entities:search",
          "response": {
            "$ref": "SearchResponse"
          }
        }
      }
    }
  },
  "revision": "20180809",
  "rootUrl": "https://kgsearch.googleapis.com/",
  "schemas": {
    "SearchResponse": {
      "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
      "id": "SearchResponse",
      "properties": {
        "@context": {
          "description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
          "type": "any"
        },
        "@type": {
          "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
          "type": "any"
        },
        "itemListElement": {
          "description": "The item list of search results.",
          "items": {
            "type": "any"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "servicePath": "",
  "title": "Knowledge Graph Search API",
  "version": "v1",
  "version_module": true
}