> For the complete documentation index, see [llms.txt](https://docs.konvu.com/konvu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.konvu.com/konvu/reference/api-documentation.md).

# API Documentation

Konvu exposes a REST API for programmatic access to findings, assessments, and metrics.

The Konvu API lets you query findings, manage assessments, and pull metrics programmatically. The full interactive reference is hosted at [api.konvu.com/redoc](https://api.konvu.com/redoc).

## Authentication

All API requests require an API key passed in the `Authorization` header:

```bash
curl -H "Authorization: Bearer api_YOUR_KEY_HERE" \
  https://api.konvu.com/sca_findings
```

### Generate an API key

1. Go to [app.konvu.com/configuration/api\_keys](https://app.konvu.com/configuration/api_keys)
2. Click **Create API Key**
3. Choose **Read only** or **Read and write** access
4. Copy the key -- it won't be shown again

API keys are scoped to your organization. Store them securely and rotate them periodically.

### Choose an access level

Access applies across the Konvu API, including SCA, SAST, secrets, vulnerability reports, coverage, and remediation.

| Access             | Allowed requests                 | Use it for                                                                                                                                         |
| ------------------ | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Read only**      | `GET`, `HEAD`, and `OPTIONS`     | Listing and reading findings, assessments, reports, reproduction evidence, metrics, inventory, coverage, and remediation status.                   |
| **Read and write** | All read requests plus mutations | Submitting findings or reports; assessing, rating, dismissing, or reopening SCA and SAST findings or reports; changing coverage; starting actions. |

The dashboard defaults new keys to **Read only**. Keys created before access levels were introduced remain **Read and write** so existing automations continue to work. You cannot change a key's access level after creation; create a replacement key and revoke the old one.

A read-only key that sends `POST`, `PUT`, `PATCH`, or `DELETE` receives `403 Forbidden` before the request reaches the endpoint. **Read and write** does not bypass organization scope, feature availability, or endpoint-specific authorization.

## Base URL

```
https://api.konvu.com
```

## Interactive reference

The interactive reference for Konvu's public REST endpoints, request and response schemas, and parameters is available at:

[**https://api.konvu.com/redoc**](https://api.konvu.com/redoc)

{% hint style="info" %}
If you prefer working from the terminal, the [Konvu CLI](/konvu/reference/cli.md) wraps the same API with built-in authentication, output formatting, and filtering.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.konvu.com/konvu/reference/api-documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.