# getOpenalexWork

**Identifier:** `openalex_getOpenalexWork`

**Provider:** [OpenAlex](https://kirha.com/providers/openalex.md)

Get full metadata for a single scholarly work by OpenAlex ID, DOI, PMID, or PMCID.

## Run it with the CLI

```bash
kirha tools run openalex_getOpenalexWork \
  --input '{
    "id": "<id>"
  }'
```

`--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": "openalex_getOpenalexWork",
  "input": {
    "id": "<id>"
  }
}'
```

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": {
    "id": {
      "description": "OpenAlex ID (W2741809807), DOI (doi:10.1038/...), PMID (pmid:12345), or full DOI URL",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "abstract": {
      "type": "string"
    },
    "authorCount": {
      "type": "number"
    },
    "authorIds": {
      "description": "For use with getOpenalexAuthor or getOpenalexAuthorWorks",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "authors": {
      "description": "First 300 authors",
      "items": {
        "additionalProperties": false,
        "properties": {
          "countries": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "description": "For use with getOpenalexAuthor or getOpenalexAuthorWorks",
            "type": "string"
          },
          "institutions": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "isCorresponding": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "orcid": {
            "type": "string"
          },
          "position": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "citationPercentile": {
      "type": "number"
    },
    "citedByCount": {
      "type": "number"
    },
    "context": {
      "type": "string"
    },
    "doi": {
      "type": "string"
    },
    "funders": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "fwci": {
      "type": "number"
    },
    "id": {
      "type": "string"
    },
    "isInTop10Percent": {
      "type": "boolean"
    },
    "isInTop1Percent": {
      "type": "boolean"
    },
    "isOa": {
      "type": "boolean"
    },
    "isRetracted": {
      "type": "boolean"
    },
    "issue": {
      "type": "string"
    },
    "keywords": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "language": {
      "type": "string"
    },
    "license": {
      "type": "string"
    },
    "oaStatus": {
      "type": "string"
    },
    "oaUrl": {
      "type": "string"
    },
    "pages": {
      "type": "string"
    },
    "pdfUrl": {
      "type": "string"
    },
    "publicationDate": {
      "type": "string"
    },
    "publicationYear": {
      "type": "number"
    },
    "referencedWorksCount": {
      "type": "number"
    },
    "relatedWorkIds": {
      "description": "For use with getOpenalexWork",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sdgs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sourceIds": {
      "description": "For use with searchOpenalexWorks sourceIds filter",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "sourceName": {
      "type": "string"
    },
    "sourceType": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "topicDomain": {
      "type": "string"
    },
    "topicField": {
      "type": "string"
    },
    "topicName": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "volume": {
      "type": "string"
    }
  },
  "required": [
    "context",
    "id",
    "title"
  ],
  "type": "object"
}
```

## Related tools

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

- [`getOpenalexWorksCited`](https://kirha.com/providers/openalex/getOpenalexWorksCited.md)
- [`getOpenalexAuthor`](https://kirha.com/providers/openalex/getOpenalexAuthor.md)
- [`searchOpenalexWorks`](https://kirha.com/providers/openalex/searchOpenalexWorks.md)
- [`getOpenalexAuthorWorks`](https://kirha.com/providers/openalex/getOpenalexAuthorWorks.md)

-----

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