> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nelkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nelkap

> The client your workflows, your route, and your code use to reach Nelkap.

```ts theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
new Nelkap(options?: NelkapOptions)
```

## Options

**apiKey** `string`

An API key of your project. Defaults to `NELKAP_API_KEY`.

**secret** `string`

Your project's secret, which [`handle`](https://docs.nelkap.com/reference/handle) checks on each call. Defaults to `NELKAP_SECRET`.

**apiUrl** `string`

The address of the Nelkap API. Defaults to `NELKAP_API_URL`, or `https://api.nelkap.com` when it isn't set.

## Methods

| Method | What it does |
| - | - |
| [`registerWorkflows`](https://docs.nelkap.com/reference/register-workflows) | Sets your project's workflows and sends them to Nelkap. |
| [`run`](https://docs.nelkap.com/reference/run) | Starts a run of a workflow. |
| [`emit`](https://docs.nelkap.com/reference/emit) | Emits an event. |
| [`handle`](https://docs.nelkap.com/reference/handle) | Answers the calls Nelkap makes to your endpoint. |
| [`step`](https://docs.nelkap.com/reference/step-run) | The steps of a workflow: `run`, `sleep`, `wait`, and `score`. |

## Exports

```ts theme={"theme":{"light":"light-plus","dark":"dark-plus"}}
import { Nelkap, NelkapError, StepError } from '@nelkap/sdk';
import type { EmitEventInput, NelkapOptions, Workflow, WorkflowHandler } from '@nelkap/sdk';
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.