Start Analysis

Initiates a background analysis task for a repository

POST /api/analysis/start

cURL

github

curl --request POST \
  --url https://api.codeant.ai/api/analysis/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": "owner/repository",
  "commit_id": "abc123def456",
  "access_token": "ghp_xxxxxxxxxxxx",
  "service": "github",
  "branch": "main",
  "include_files": "src/**/*.py,lib/**/*.js,app/**/*.ts",
  "exclude_files": "tests/**,node_modules/**,dist/**"
}
'

200

{
  "message": "Analysis started"
}

Body

application/json

repo · string · required

Repository identifier (format varies by service)

Example:

"owner/repository"

commit_id · string · required

Git commit SHA or identifier

Example:

"abc123def456"

access_token · string · required

Authentication token for the service

Example:

"ghp_xxxxxxxxxxxx"

service · enum<string> · required

Version control service provider

Available options: github, azuredevops, gitlab, bitbucket

Example:

"github"

branch · string

Git branch name

Example:

"main"

include_files · string

Comma-separated file patterns to include in analysis

Example:

"src/**/*.py,lib/**/*.js,app/**/*.ts"

exclude_files · string

Comma-separated file patterns to exclude from analysis

Example:

"tests/**,node_modules/**,dist/**"

Response

200

application/json

Analysis successfully started

message · string

Success message