Overview and authentication

Overview

The Vantik REST API creates, reads, updates, and deletes an issue, a comment, a label, a linked issue, and more. An agent or a script therefore plans and tracks its work through this API. The sidebar holds the reference for every endpoint.

Your own instance serves the API under /api. In local development the address is http://localhost:3001/api. Behind the webapp proxy the address is https://your-domain.com/api.

Authentication

Make a personal access token (PAT) in the webapp, under Settings → My Account → Api. Then send the token with each request:

curl -H "Authorization: Bearer $VANTIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Issue title", "description": "Issue description", "teamId": "..."}' \
  https://your-domain.com/api/v1/issues

A PAT stays valid until you delete it on the same settings page. An agent that runs for a long time, and a scheduled job, can therefore use it. Keep a PAT as safe as a password, because it holds all the permissions of the user who made it.

The TypeScript SDK

The repository holds a Node.js SDK with types, in packages/vantik-sdk. The maintainers do not publish it to npm. If you work inside the monorepo, use it from the workspace. If you work outside, build it from the source:

import { configure, createIssue } from "@vantikhq/sdk";

configure({
  // You can omit this if the VANTIK_TOKEN environment variable holds the token
  token: "<token>",
});

await createIssue({
  title: "Issue title",
  description: "Issue description",
});