API playground
Build a request. Inspect the response. Explore all 25 public APIs.
Loading API playground...
Build a request. Inspect the response. Explore all 25 public APIs.
Loading API playground...
Reserves one unit from the shared reviews_scans pool. Repeating this request creates another job.
https://api.codity.ai/v1/reviewYour key sets organization access. Never saved to browser storage.
Complete the required inputs before sending.
Reserves one unit from the shared reviews_scans pool. Repeating this request creates another job.
14 body parameters · 1 required. Only included fields are sent.
diffstringRequiredUnified diff, maximum 5 MiB UTF-8.
repostring | nullOptionalProvide repo or repo_url. To set repo to null, provide repo_url first.
Add repo_url before setting repo to null.
providerstringOptionalcli, github, gitlab, azure or bitbucket. azure_devops and hyphen aliases are normalized upstream.
Default: "cli".
filesarrayOptionalDefault: []. Maximum: 200.
pathstringRequiredcontentstringRequiredrepo_urlstring | nullnull.ownerstring | nullnull.repostring | nullnull.providerstring"cli".branchstring | nullnull.commit_shastring | nullnull.pr_numberinteger0.filesarray[]. Bounds: 0 to 200.files[].pathstringrequiredfiles[].contentstringrequiredauth_contextobject{}.model_namestring | nullnull.diffstringrequireddiff_sourcestring"api".context_mdstring | nullnull.context_hashstring | nullnull.repo or repo_url is required. Non-cli reviews require a positive pr_number. CLI reviews, navigation and automation require files. Limits: 5 MiB diff, 200 files, 2 MiB per file and 20 MiB combined.
{
"job_id": "11111111-1111-4111-8111-111111111111",
"workflow_id": "22222222-2222-4222-8222-222222222222",
"status": "accepted"
}Your key stays in memory. Requests run against the live API.
Existing API keys cannot be recovered. Create or manage keys in your Codity account. Requests run against the live API; examples are illustrative.