# searchZenodo

**Identifier:** `zenodo_searchZenodo`

**Provider:** [Zenodo](https://kirha.com/providers/zenodo.md)

Search Zenodo for research outputs including datasets, publications, software, and more. Supports Elasticsearch query syntax for advanced searches.

## Run it with the CLI

```bash
kirha tools run zenodo_searchZenodo \
  --input '{
    "query": "title:climate"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "zenodo_searchZenodo",
  "input": {
    "query": "title:climate"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "accessRight": {
      "enum": [
        "open",
        "embargoed",
        "restricted",
        "closed"
      ],
      "type": "string"
    },
    "allVersions": {
      "default": false,
      "type": "boolean"
    },
    "communities": {
      "type": "string"
    },
    "limit": {
      "default": 10,
      "maximum": 25,
      "minimum": 1,
      "type": "number"
    },
    "page": {
      "default": 1,
      "minimum": 1,
      "type": "number"
    },
    "query": {
      "description": "Search query with Elasticsearch syntax. Simple: just keywords like 'machine learning'. Field search: field:value (e.g. title:climate, creators.name:Smith, doi:10.5281*). Phrases: \"exact phrase\". Boolean: term1 AND term2, term1 OR term2, NOT term. Common fields: title, description, keywords, creators.name, creators.affiliation, doi, language, journal.title. Check field exists: _exists_:pids.doi. Date ranges: publicationdate:[2020 TO 2024]. Examples: 'neural network', 'title:\"deep learning\" AND creators.name:Smith', 'keywords:climate AND _exists_:pids.doi'.",
      "type": "string"
    },
    "sort": {
      "default": "bestmatch",
      "enum": [
        "bestmatch",
        "mostrecent",
        "-mostrecent"
      ],
      "type": "string"
    },
    "subtype": {
      "description": "e.g., 'article', 'preprint', 'dissertation', 'conferencepaper'",
      "type": "string"
    },
    "type": {
      "enum": [
        "publication",
        "dataset",
        "software",
        "poster",
        "presentation",
        "image",
        "video",
        "lesson",
        "physicalobject",
        "other"
      ],
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "ids": {
      "description": "Record IDs of the results, usable with getZenodoRecord and getZenodoFileUrl",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "limit": {
      "type": "number"
    },
    "page": {
      "type": "number"
    },
    "records": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "accessRight": {
            "type": "string"
          },
          "creators": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "affiliation": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "orcid": {
                  "type": "string"
                }
              },
              "required": [
                "name"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "description": {
            "type": "string"
          },
          "doi": {
            "type": "string"
          },
          "fileCount": {
            "type": "number"
          },
          "id": {
            "type": "string"
          },
          "keywords": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "license": {
            "type": "string"
          },
          "links": {
            "additionalProperties": false,
            "properties": {
              "doi": {
                "type": "string"
              },
              "self": {
                "type": "string"
              }
            },
            "required": [
              "self"
            ],
            "type": "object"
          },
          "publicationDate": {
            "type": "string"
          },
          "resourceType": {
            "additionalProperties": false,
            "properties": {
              "subtype": {
                "type": "string"
              },
              "type": {
                "type": "string"
              }
            },
            "required": [
              "type"
            ],
            "type": "object"
          },
          "title": {
            "type": "string"
          },
          "totalSize": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "title",
          "creators",
          "keywords",
          "resourceType",
          "accessRight",
          "fileCount",
          "totalSize",
          "links"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "totalHits": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "totalHits",
    "ids",
    "page",
    "limit",
    "records"
  ],
  "type": "object"
}
```

## Related tools

Other Zenodo tools that this tool refers to, or that refer to it.

- [`getZenodoRecord`](https://kirha.com/providers/zenodo/getZenodoRecord.md)
- [`getZenodoFileUrl`](https://kirha.com/providers/zenodo/getZenodoFileUrl.md)

-----

[All Zenodo tools](https://kirha.com/providers/zenodo.md) · [< Back to tools list](https://kirha.com/tools.md)