Askara

Agent integration

Connect Claude to your instance

Follow these steps to generate an API key and plumb the risk-analysis skill into your instance, so the analysis it produces is saved to your graph and shows up in your Risk Register — no prior setup knowledge required.

Get started

The risk-analysis skill produces structured analysis files. With an instance API key you can connect that skill to Askara so each result is saved straight into your graph and appears in your Risk Register. You will need three things:

  • An Askara account with access to an instance
  • An instance API key (covered below)
  • The risk-analysis skill running in Claude Desktop or Cowork

Generate an API key

The skill authenticates to your instance with an API key. The key is shown once when it is created, so copy it somewhere safe immediately.

You'll need your technical team

Generating API keys requires Platform Administrator access, which your account does not have. Contact your technical team and ask them to generate an instance API key for you.

Connect the skill to your instance

Connecting the skill is two pieces: give it API access (your key and the API address), and point it at the live API documentation. The skill reads the docs and works out the API calls itself.

1. Give the skill API access

Create a file called askara.env next to your skill and paste this in, replacing <YOUR_INSTANCE_API_KEY> with the key you generated:

bash
# askara.env  —  keep this file private, never commit it
ASKARA_API_KEY=<YOUR_INSTANCE_API_KEY>
ASKARA_API_BASE=https://staging-api.askara.solutions

Use the API address, not the app address

ASKARA_API_BASE must point at the API host directly (the address above). If you send requests through the normal app address, your X-API-Key is removed and the skill will be rejected.

2. Point the skill at the API docs

The skill learns the available endpoints and their exact request shapes from the live API documentation for your instance:

https://staging-api.askara.solutions/docs — interactive docs. Machine-readable schema: https://staging-api.askara.solutions/openapi.json

Add this to the skill's SKILL.md so it knows where the API is, how to authenticate, and to read the docs before writing anything:

markdown
## Using the Askara API

The Askara API for this instance is at $ASKARA_API_BASE. Authenticate every
request with this header:

    X-API-Key: $ASKARA_API_KEY

Before writing anything, read the live API documentation to learn the available
endpoints and their exact request bodies:

  - Interactive docs (Swagger UI):  $ASKARA_API_BASE/docs
  - Machine-readable schema:        $ASKARA_API_BASE/openapi.json

Then translate your risk assessment into the matching API calls so it is
reflected in the instance graph: create an assessment and its outputs, then
create the risks, loss scenarios, concepts and controls. Use the typed
endpoints — they record the relationships between entities for you. Treat the
OpenAPI schema as the source of truth for field names and required values — do
not guess.

Run the skill

Ask Claude to run the risk-analysis skill for a company. Using the docs and your key, the skill turns its analysis into the right API calls — creating the assessment and its outputs, then the risks, loss scenarios, concepts and controls — so everything is reflected in your instance graph.

Once a run finishes, your Risk Register fills with the risks the skill created.

See your risks in the graph

The risks the skill saved appear in your Risk Register, where you can review severity, loss estimates, and relationships.

Open the Risk Register

Permissions & troubleshooting

An instance API key is deliberately limited. When in doubt, contact your technical team rather than changing settings you are unsure about.

The key can

  • Create and read risks, assessments and assessment outputs
  • Create loss scenarios, concepts, controls, control objectives and standards
  • Read the graph

The key cannot

  • Update an existing risk — a person reviews and approves changes
  • Do anything outside creating and reading risk data — the key is scoped to risk analysis

401 Unauthorized

Your API key is missing, mistyped, or has been revoked, or you sent the request through the app address instead of the API address. Re-check askara.env, and if needed ask your technical team for a fresh key.

403 Forbidden

The key is valid but is not allowed to do that. Creating risks is allowed; updating an existing risk is reserved for people. Your technical team can confirm your instance access.

The docs link returns 404

Some instances do not expose the API docs. If https://staging-api.askara.solutions/docs does not load, ask your technical team to enable documentation access for your instance.

Still stuck?

Reach out to your technical team with the step you were on and any error message — they can check your instance access and key configuration.