#080Technical3 min

Discover the Hackaiz API

Understand personal-key endpoints, asynchronous requests and scope limits before building an integration.

Hackaiz team · updated 21/11/2026

Illustration: a developer uses an editor and a terminal.
Illustration: a developer uses an editor and a terminal. Illustrative photo, not a screenshot.

01Use the API for an authorized account workflow

The project implements versioned HTTP endpoints under /api/public/v1. They support account platform listing, platform analysis requests, request status and finding retrieval, as well as workspace and component checks. “Public” describes the API route namespace, not anonymous access to somebody else’s reports. The connected CLI and editor extension are concrete examples of clients using these interfaces. Their source is useful for understanding the request shapes actually implemented.

Choose the integration model before coding. Remote MCP at /mcp uses an OAuth account flow for assistants. The connected CLI and editor use a personal key. A platform-scoped read-only integration is not automatically authorized to launch analyses on every platform. Do not interchange these credentials or copy an assistant session into a script. Prefer the narrowest access that can perform the intended operation, and keep a separate record of the platform identifiers you deliberately allow.

02Keep authentication out of project content

The connected CLI sends the personal key using the Authorization header with the Bearer scheme. Its environment variable is HACKAIZ_API_KEY; a valid-looking key begins with hkz_. Obtain and manage personal keys through Hackaiz Settings and Integrations. The server checks ownership, permissions and allowed platforms rather than trusting an identifier supplied by the client. Reading and launching are separate permissions, and revoked or expired access must not be treated as a transient success.

Keep the key in your execution environment or the secret store of your automation system. Do not include it in repository files, request URLs, support screenshots or logs. The CLI only accepts an HTTPS origin and rejects redirects for requests. Follow that pattern in your own client so a changed destination does not silently receive the authorization header. For troubleshooting, record the route and sanitized error, not the full authenticated request.

03Follow a request instead of replaying an analysis

The CLI posts to /api/public/v1/projects/{projectId}/analysis-requests with a request_key and a channel. It then reads /api/public/v1/projects/{projectId}/analysis-runs/{runId}. The returned requestId identifies the existing request. Retain it together with your stable request key. If the connection fails after work starts, consult that same request instead of creating a replacement that could trigger additional credit-using work.

An accepted request is not a completed security result. Processing can finish successfully, partially or with failure, and the prepared client reports when autonomous processing needs configuration. The integration page states that autonomous processing must be deployed and synchronized and does not confirm a real customer-account run. A partial report does not establish complete coverage. Build an inconclusive state into your consumer rather than representing missing or unfinished data as “no vulnerabilities”.

04Read bounded results and preserve product safeguards

Findings are available at /api/public/v1/projects/{projectId}/findings. The CLI verification path filters by the scan linked to its request and reads paginated findings, rather than assuming the first page is complete. If you build a release check, preserve that link between request, analysis and findings. A saved-platform analysis does not automatically verify the commit of a pull request or a particular deployment. Document that limitation in the status you display.

Analyses use credits. Websites and APIs require domain proof through _hackaiz DNS TXT, the HTTPS verification file or its creation by the project AI before analysis. Repository access alone does not satisfy this. API access also does not authorize automatic correction publication: Hackaiz fixes are draft GitHub pull requests reviewed and approved by a person, never merged automatically. For component checks, submitted text is checked statically; the endpoint is not a remote execution service.

Frequently asked questions

Was this article helpful?

Related articles