{"openapi":"3.1.0","info":{"title":"AIScan API","description":"Security scanner for software built with AI. Every scan runs in the background: start it, keep the returned id, then read the result until its status is `done`. No account is needed; a fair use limit per IP address applies.\n\nSetup for the MCP server, the command line and CI: [developer overview](/developers).","contact":{"name":"VisionEdge, s. r. o.","url":"https://visionedge.sk/","email":"info@visionedge.sk"},"version":"1.7.8"},"paths":{"/api/health":{"get":{"tags":["Service"],"summary":"Health check","operationId":"health_api_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Api Health Get"}}}}}},"head":{"tags":["Service"],"summary":"Health check","operationId":"health_api_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Health Api Health Get"}}}}}}},"/api/meta":{"get":{"tags":["Service"],"summary":"Limits and configuration","operationId":"meta_api_meta_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Meta Api Meta Get"}}}}}}},"/api/scans/url":{"post":{"tags":["Scans"],"summary":"Scan a website","operationId":"scan_url_endpoint_api_scans_url_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlScanRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scan Url Endpoint Api Scans Url Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/scans/llm":{"post":{"tags":["Scans"],"summary":"Test a chatbot (verified domain only)","operationId":"scan_llm_endpoint_api_scans_llm_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMScanRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scan Llm Endpoint Api Scans Llm Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/scans/code":{"post":{"tags":["Scans"],"summary":"Scan code from a ZIP upload","operationId":"scan_code_upload_api_scans_code_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_scan_code_upload_api_scans_code_post"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scan Code Upload Api Scans Code Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/scans/repo":{"post":{"tags":["Scans"],"summary":"Scan a public GitHub repository","operationId":"scan_repo_api_scans_repo_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RepoScanRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Scan Repo Api Scans Repo Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/scans/{scan_id}":{"get":{"tags":["Scans"],"summary":"Scan status and results","operationId":"get_scan_api_scans__scan_id__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Scan Api Scans  Scan Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Scans"],"summary":"Delete a scan report","operationId":"delete_scan_api_scans__scan_id__delete","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Scan Api Scans  Scan Id  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/scans/{scan_id}/report.{fmt}":{"get":{"tags":["Scans"],"summary":"Download the report as json, sarif, md, html or cdx","operationId":"download_report_api_scans__scan_id__report__fmt__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}},{"name":"fmt","in":"path","required":true,"schema":{"type":"string","title":"Fmt"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/verifications":{"post":{"tags":["Domain verification"],"summary":"Start a domain verification","operationId":"create_verification_api_verifications_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Create Verification Api Verifications Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/verifications/{vid}/check":{"post":{"tags":["Domain verification"],"summary":"Check the verification record","operationId":"check_verification_api_verifications__vid__check_post","parameters":[{"name":"vid","in":"path","required":true,"schema":{"type":"string","title":"Vid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Check Verification Api Verifications  Vid  Check Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/feed":{"get":{"tags":["Threat feed"],"summary":"Newest vulnerabilities in AI packages","operationId":"feed_api_feed_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":60,"title":"Limit"}},{"name":"ecosystem","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ecosystem"}},{"name":"min_severity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Min Severity"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Feed Api Feed Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/feed/status":{"get":{"tags":["Threat feed"],"summary":"Feed refresh status","operationId":"feed_status_api_feed_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Feed Status Api Feed Status Get"}}}}}}},"/api/live":{"get":{"tags":["Threat feed"],"summary":"Data for the live ticker","description":"Small, fast payload for the live ticker on the home page.","operationId":"live_api_live_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Live Api Live Get"}}}}}}},"/api/scans/{scan_id}/watch":{"post":{"tags":["Live monitoring"],"summary":"Start watching a scanned project","operationId":"watch_scan_api_scans__scan_id__watch_post","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatchRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Watch Scan Api Scans  Scan Id  Watch Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{pid}":{"get":{"tags":["Live monitoring"],"summary":"Project status and alerts","operationId":"get_project_api_projects__pid__get","parameters":[{"name":"pid","in":"path","required":true,"schema":{"type":"string","title":"Pid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Project Api Projects  Pid  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Live monitoring"],"summary":"Stop monitoring and delete the project","operationId":"delete_project_api_projects__pid__delete","parameters":[{"name":"pid","in":"path","required":true,"schema":{"type":"string","title":"Pid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Project Api Projects  Pid  Delete"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{pid}/check":{"post":{"tags":["Live monitoring"],"summary":"Check the project now","operationId":"check_project_now_api_projects__pid__check_post","parameters":[{"name":"pid","in":"path","required":true,"schema":{"type":"string","title":"Pid"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Check Project Now Api Projects  Pid  Check Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{pid}/webhook":{"put":{"tags":["Live monitoring"],"summary":"Set the alert webhook","operationId":"set_webhook_api_projects__pid__webhook_put","parameters":[{"name":"pid","in":"path","required":true,"schema":{"type":"string","title":"Pid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Set Webhook Api Projects  Pid  Webhook Put"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/projects/{pid}/webhook/test":{"post":{"tags":["Live monitoring"],"summary":"Send a test alert","operationId":"test_webhook_api_projects__pid__webhook_test_post","parameters":[{"name":"pid","in":"path","required":true,"schema":{"type":"string","title":"Pid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Test Webhook Api Projects  Pid  Webhook Test Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_scan_code_upload_api_scans_code_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_scan_code_upload_api_scans_code_post"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LLMScanRequest":{"properties":{"url":{"type":"string","title":"Url"},"method":{"type":"string","title":"Method","default":"POST"},"headers":{"additionalProperties":{"type":"string"},"type":"object","title":"Headers"},"body_template":{"type":"string","title":"Body Template","default":"{\"message\": \"{{prompt}}\"}"},"response_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response Path"},"system_prompt_canary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System Prompt Canary"},"delay_seconds":{"type":"number","maximum":10.0,"minimum":0.2,"title":"Delay Seconds","default":1.0},"max_probes":{"type":"integer","maximum":60.0,"minimum":1.0,"title":"Max Probes","default":30},"verification_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Id"},"verification_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Secret"}},"type":"object","required":["url"],"title":"LLMScanRequest"},"RepoScanRequest":{"properties":{"repo_url":{"type":"string","title":"Repo Url","description":"Link to a public GitHub repository."}},"type":"object","required":["repo_url"],"title":"RepoScanRequest","examples":[{"repo_url":"https://github.com/owner/repo"}]},"UrlScanRequest":{"properties":{"url":{"type":"string","title":"Url","description":"Public website address. Private and local addresses are refused."},"deep":{"type":"boolean","title":"Deep","description":"Deep checks of unlinked files and database rules. Needs a verified domain.","default":false},"verification_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Id","description":"From POST /api/verifications, only for deep scans."},"verification_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Secret","description":"Secret returned with the verification, only for deep scans."}},"type":"object","required":["url"],"title":"UrlScanRequest","examples":[{"deep":false,"url":"https://example.com"}]},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerificationRequest":{"properties":{"domain":{"type":"string","title":"Domain"}},"type":"object","required":["domain"],"title":"VerificationRequest"},"WatchRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}],"title":"Name"}},"type":"object","title":"WatchRequest"},"WebhookRequest":{"properties":{"url":{"type":"string","title":"Url","default":""}},"type":"object","title":"WebhookRequest"}}},"tags":[{"name":"Scans","description":"Start scans of code, GitHub repositories, websites and chatbots, read results and download reports."},{"name":"Live monitoring","description":"Watch the packages of a scanned project and get alerts when a new vulnerability affects them."},{"name":"Threat feed","description":"Newest vulnerabilities in AI packages from OSV, GitHub advisories, CISA KEV and EPSS."},{"name":"Domain verification","description":"Prove that you own a domain to unlock deep website scans and chatbot tests."},{"name":"Service","description":"Health and configuration of this instance."}]}