GitHub Search Code

1 credits/call
ae_github_search_code

Find specific code—like functions, classes, or keywords—inside files across GitHub repositories, with filters for language, repository, filename, or content.

Productivity
1 credits/call

Pricing

1 credits/call
ConditionCharge
Each call1 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
qstringYesThe query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers.—
pageintegerNoThe page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."1
sortenum (indexed)No**This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)—
orderenum (desc | asc)No**This field is closing down.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. desc
per_pageintegerNoThe number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."30

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_search_code' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "per_page": 5,
    "q": "PaddleOCR(lang= repo:PaddlePaddle/PaddleOCR language:python"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "incomplete_results": false,
  "items": [
    {
      "git_url": "https://api.github.com/repositories/262296122/git/blobs/4a0a675a3a73802254b0afaaabf9597b58062076",
      "html_url": "https://github.com/PaddlePaddle/PaddleOCR/blob/dab3fe35379033fdcb2d0e9572fac0b36c9a9ebf/tests/pipelines/test_ocr.py",
      "name": "test_ocr.py",
      "path": "tests/pipelines/test_ocr.py",
      "repository": {
        "archive_url": "https://api.github.com/repos/PaddlePaddle/PaddleOCR/{archive_format}{/ref}",
        "assignees_url": "https://api.github.com/repos/PaddlePaddle/PaddleOCR/assignees{/user}",
        "blobs_url": "https://api.github.com/repos/PaddlePaddle/PaddleOCR/git/blobs{/sha}",
        "id": 262296122,
        "name": "PaddleOCR",
        "url": "https://api.github.com/repos/PaddlePaddle/PaddleOCR"
      },
      "url": "https://api.github.com/repositories/262296122/contents/tests/pipelines/test_ocr.py?ref=dab3fe35379033fdcb2d0e9572fac0b36c9a9ebf"
    }
  ],
  "total_count": 1
}

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