GitHub Repos Get Readme

1 credits/call
ae_github_repos_get_readme

Get the main README file from a GitHub repository—either as raw text or rendered HTML.

Productivity
1 credits/call

Pricing

1 credits/call
ConditionCharge
Each call1 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
refstringNoThe name of the commit/branch/tag. Default: the repository’s default branch.—
repostringYesThe name of the repository without the `.git` extension. The name is not case sensitive.—
ownerstringYesThe account owner of the repository. The name is not case sensitive.—

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_github_repos_get_readme' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "owner": "mokevnin",
    "repo": "agentic-coding-design-patterns"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "_links": {
    "git": "https://api.github.com/repos/mokevnin/agentic-coding-design-patterns/git/blobs/615fd77e811cc267310b965f2961bec26181f65a",
    "html": "https://github.com/mokevnin/agentic-coding-design-patterns/blob/main/README.md",
    "self": "https://api.github.com/repos/mokevnin/agentic-coding-design-patterns/contents/README.md?ref=main"
  },
  "content": "IyBBZ2VudGljIENvZGluZyBEZXNpZ24gUGF0dGVybnMKCkEgY2F0YWxvZyBv\nZiBwYXR0ZXJucyBpbiB0aGUgc3Bpcml0IG9mIHRoZSAiR2FuZyBvZiBGb3Vy\nIiAoR29GKSBhYm91dCAqKmhvdyBhCmRldmVsb3BlciB3b3JrcyB3aXRoIGFu\nIEFJIGFnZW50IHdoZW4gd3JpdGluZyBjb2RlKiouIEl0IGlzIGEgYm9vayBi\ndWlsdCBmcm9t",
  "download_url": "https://raw.githubusercontent.com/mokevnin/agentic-coding-design-patterns/main/README.md",
  "name": "README.md",
  "type": "file",
  "url": "https://api.github.com/repos/mokevnin/agentic-coding-design-patterns/contents/README.md?ref=main"
}

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

Guides using this tool

See how this tool fits into real workflows