OpenAlex Listworks

1 credits/call
ae_openalex_listworks

Search OpenAlex for scholarly works, including articles, books, and datasets, with filters, sorting, and grouping.

AcademicSearch
1 credits/call

Pricing

1 credits/call
ConditionCharge
Each call1 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
sortstringNo按字段排序。支持 `cited_by_count`、`publication_date` 和 `relevance_score`;`relevance_score` 仅在提供搜索条件时使用。默认按升序排序;如需降序,请在字段名后添加 `:desc`,例如 `cited_by_count:desc`。多个排序字段用英文逗号分隔。不要使用 `-` 前缀表示降序。—
filterstringNoFilter works. Examples: `publication_year:2023`, `type:article`, `open_access.is_oa:true`, `author.id:A5023888391`, `institutions.id:I27837315`, `cited_by_count:>100` See [all Work fields](/api-reference/works#available-filter-sort-and-group_by-fields).—
group_bystringNoGroup by: `publication_year`, `type`, `open_access.is_oa`, `authorships.institutions.country_code` See [all Work fields](/api-reference/works#available-filter-sort-and-group_by-fields).—

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_openalex_listworks' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "filter": "title.search:sole trader succession",
    "per_page": 15,
    "sort": "relevance_score:desc"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "group_by": [],
  "meta": {
    "cost_usd": 0.001,
    "count": 0,
    "db_response_time_ms": 15,
    "groups_count": null,
    "page": 1,
    "per_page": 15
  },
  "results": []
}

This example shows part of the response. Copied content is valid JSON.

Guides using this tool

See how this tool fits into real workflows