Alphaxiv Read Files From GitHub Repository
Reads files or directories from a GitHub repository, including a paper's project website source. For owner.github.io sites, try owner/owner.github.io; for owner.github.io/project/, try owner/project first. These are candidates, not guaranteed source repositories. For project videos, read the webpage first. Inspect website source only when the page omits a playable URL for a needed demo; do not recheck assets the page already exposes. Look in HTML, components, and asset manifests. Special behaviors: 1. When path is '/', returns repository structure and the contents of top-level files. Large repositories may be limited to top-level entries. 2. When path points to a directory, returns a list of files and directories, with contents of readable files fetched in parallel. Omitted files include a reason and raw URL when available. 3. When path points to a file, returns its contents. Binary files are rejected with a raw URL; PDFs should be queried with answer_pdf_queries.
Pricing
| Condition | Charge |
|---|---|
| Each call | 1 credits/call |
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
path | string | Yes | The path to the file or directory. Use '/' to get the entire repository structure. | — |
githubUrl | string | Yes | The GitHub repository URL, including project website repositories. | — |
Invocation example
Parameter templateGenerated from the parameter configuration. Replace the sample values before use.
/agent-api/v1/tool/executeX-Api-Keycurl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_alphaxiv_read_files_from_github_repository' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"path": "xxx",
"githubUrl": "https://example.com/image.jpg"
}
}'No response example available yet.






