Parsing codebase

POST /parse

This endpoint allows you to parse the codebases that the GitHub app has access to. Ensure the app has the necessary permissions to access the repositories you want to parse. You can update the app's access permissions through the GitHub app installation settings.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Sample

repo_name

string

username/repo-name

branch_name

string

feature

Response

{
  "status": "success",
  "message": "The project has been parsed successfully"
}

Notes

  • Ensure that the Authorization header contains a valid token obtained during the login process.

  • The repo_name should be in the format username/repo-name , do not use a complete url.

  • The branch_name should be a valid branch in the specified repository.

Last updated

Was this helpful?