martin65536/liquid-glass-webgl/aminer-academic-search

AMiner Open Platform Academic Data Query

28 APIs + 5 workflows. Token required: set AMINER_API_KEY env var.

• Docs: https://open.aminer.cn/open/docs | Console: https://open.aminer.cn/open/board?tab=control

Mandatory Rules (Critical)

1. Token Security: Only check whether AMINER_API_KEY exists; never expose the token in plain text anywhere.
2. Cost Control: Prefer optimal combined queries; never do indiscriminate full-detail retrieval. Default to top 10 details when the user has not specified a count.
3. Free-First: Prefer free APIs unless the user explicitly requires deeper fields; only upgrade to paid APIs when free ones cannot satisfy the need.
4. Result Links: Always append an accessible URL after each entity in the output.
5. Disambiguation: Scholar ambiguity → filter by org/org_id or ask user to confirm. Org ambiguity → use org_disambiguate_pro. Paper ambiguity → cross-check year + venue_name + first_author.
6. Cost Report: After completing all API calls, always output a cost summary to the user showing: each API called, its unit price, number of calls, and the total cost. Format example: [Cost] ¥X.XX total, N API calls (api_a: ¥X.XX × N, api_b: Free × N).
7. High-Cost Confirmation (≥ ¥5): Before executing a workflow or call chain whose estimated total cost is ¥5.00 or more, stop and ask the user for confirmation first. Show the planned call chain, estimated cost per step, and the total. Only proceed after the user explicitly agrees. This applies to both predefined workflows (e.g., Scholar Profile ~¥6.00) and ad-hoc multi-step plans.

Entity URL templates (mandatory):

• Paper: https://www.aminer.cn/pub/{paper_id}
• Scholar: https://www.aminer.cn/profile/{scholar_id}
• Patent: https://www.aminer.cn/patent/{patent_id}
• Journal: https://www.aminer.cn/open/journal/detail/{journal_id}

Token Check (Required)

Check AMINER_API_KEY exists before any API call. Never expose token in plain text.

[ -z "${AMINER_API_KEY+x}" ] && echo "AMINER_API_KEY missing" || echo "AMINER_API_KEY exists"

• If ${AMINER_API_KEY} exists: proceed. If not: check --token parameter. If neither: stop, guide user to Console to generate one.
• If the user provides AMINER_API_KEY inline (e.g. "My token is xxx"), accept it for the current session, but recommend setting it as an environment variable for better security.
• Default headers: Authorization: ${AMINER_API_KEY}, X-Platform: openclaw, Content-Type: application/json;charset=utf-8 (POST).

Call Guardrails

1. Parameter names and types must match references/api-catalog.md exactly.
2. paper_info is batch-only: {"ids": [...]}. paper_detail is single-paper only: one id. Never mix them.
3. When multiple details are needed, filter with a low-cost API first, then fetch details for a small set.
4. Prefer `paper_qa_search_pro`; avoid legacy `paper_qa_search`. For almost all paper Q&A / topic / filter searches, call paper_qa_search_pro first. Use legacy paper_qa_search only when the user explicitly needs topic_high / topic_middle / topic_low structured OR/AND mode that Pro does not support. Do not default to the legacy endpoint out of habit.

Paper Search API Selection Guide

When the user says "search for papers", determine the goal first:

Default routing:

1. Known title: paper_search -> paper_detail -> paper_relation
2. Conditional filtering: paper_search_pro -> paper_detail (or paper_qa_search_pro when NL intent / citation-year soft filters help)
3. Natural language / topic Q&A: always prefer paper_qa_search_pro → if empty, fall back to paper_search_pro. Do not start with legacy paper_qa_search.
4. Journal annual analysis: venue_search -> venue_paper_relation -> paper_detail_by_condition

Key paper_qa_search_pro rules:

• Default choice for natural-language paper search and multi-filter retrieval (authors/author_ids, organizations/organization_ids, venues/venue_ids, year/citation ranges, all_terms/any_terms/exclude_terms).
• Page size is fixed at 10. Do not send size. Paginate with next_cursor → next request body is {"cursor":"..."} only.
• sort: relevance / balanced / recent / citation. For “most cited” use citation; for “newest” use recent.
• Response card fields only: paper_id, title, title_zh, authors.name/name_zh, year. Use paper_detail when full abstract/keywords are needed.
• Always append https://www.aminer.cn/pub/{paper_id}.

Legacy paper_qa_search — use sparingly:

• Call only when topic_high / topic_middle / topic_low structured OR/AND is explicitly required; otherwise use Pro.
• query and topic_high/topic_middle/topic_low are mutually exclusive; do not pass both.
• Supports sci_flag, force_citation_sort, force_year_sort, author_id, org_id, venue_ids.

Free-tier screening fields available:

• paper_search: venue_name, first_author, n_citation_bucket, year
• paper_info: abstract_slice, year, venue_id, author_count
• person_search: interests, n_citation, org/org_id
• organization_search: aliases
• venue_search: aliases, venue_type
• patent_search: inventor_name, app_year, pub_year
• patent_info: app_year, pub_year

Handling Out-of-Workflow Requests

When the user's request falls outside the 5 workflows:

1. Read references/api-catalog.md to confirm available APIs, parameters, and response fields.
2. Design the shortest viable call chain: locate ID → supplement details → expand relationships.
3. Do not give up because "no existing workflow fits"; actively compose APIs based on api-catalog.

5 Combined Workflows

Workflow 1: Scholar Profile (~¥6.00)

Use Case: Complete academic profile — bio, research interests, papers, patents, projects. Cost note: Full execution exceeds the ¥5 threshold → must ask for user confirmation before proceeding (Rule 7). Show the planned steps and cost. Confirm which sub-modules are needed; skip patents/projects if not requested.

Call Chain:

Scholar search (name → person_id)
    ↓
Parallel calls (pick as needed):
  ├── Scholar details (bio/education/honors)         ¥1.00
  ├── Scholar portrait (interests/work history)      ¥0.50
  ├── Scholar papers (paper list)                    ¥1.50
  ├── Scholar patents (patent list)                  ¥1.50
  └── Scholar projects (funding info)                ¥1.50

Fallback: if paper_search yields no results in sub-steps, fall back to paper_search_pro.

Workflow 2: Paper Deep Dive (~¥0.12)

Use Case: Full paper information and citation chain from a title or keyword.

Call Chain:

Paper search / Paper search pro (title/keyword → paper_id)
    ↓
Paper details (abstract/authors/DOI/journal/year/keywords)  ¥0.01
    ↓
Paper citations (cited papers → cited_ids)                  ¥0.10
    ↓
(Optional) Batch paper_info for cited papers                Free

Fallback: if paper_search yields no results, fall back to paper_search_pro.

Workflow 3: Org Analysis (~¥0.81)

Use Case: Institution scholar size, paper output, patent count — for competitive research or partnership evaluation.

Call Chain:

Org disambiguation pro (raw string → org_id)  ¥0.05
    ↓
Parallel calls:
  ├── Org details (description/type)             ¥0.01
  ├── Org scholars (scholar list, 10/call)       ¥0.50
  ├── Org papers (paper list, 10/call)           ¥0.10
  └── Org patents (patent IDs, up to 10,000)     ¥0.10

If disambiguation pro returns no ID, fall back to org_search (free).

Workflow 4: Venue Papers (~¥0.10 - ¥0.30)

Use Case: Track journal papers by year; useful for submission research or trend analysis.

Call Chain:

Venue search (name → venue_id)                          Free
    ↓
(Optional) Venue details (ISSN/type/abbreviation)       ¥0.20
    ↓
Venue papers (venue_id + year → paper_id list)          ¥0.10
    ↓
(Optional) Batch paper detail query

Workflow 5: Patent Analysis (~¥0.02)

Use Case: Search patents in a technology domain, or retrieve a scholar's/institution's patent portfolio.

Call Chain (standalone search):

Patent search (query → patent_id)        Free
    ↓
Patent info / Patent details             Free / ¥0.01

Call Chain (via scholar/institution):

Scholar search → Scholar patents (patent_id list)
Org disambiguation → Org patents (patent_id list)
    ↓
Patent info / Patent details

Individual API Quick Reference

Full parameter docs: read references/api-catalog.md

References

• Full API parameter documentation: read references/api-catalog.md
• Optional Python client: scripts/aminer_client.py
• Test cases: evals/evals.json
• Official documentation: https://open.aminer.cn/open/docs
• Console: https://open.aminer.cn/open/board?tab=control