Vikunja API

Name: Vikunja API
Brand: Vikunja API
Availability: InStock

✓ Official Vendor SpecIdentity AuthAuthenticationapiKey, basic153 EndpointsREST

For Agents

Programmatically authenticate a user with openid connect, get an unsplash image. Covers 153 operations with apiKey, basic authentication.

Install Jentic One Beta

Connect the Vikunja API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Vikunja API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvikunja.io%2Fvikunja" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fvikunja.io%2Fvikunja" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Vikunja API.

Authenticate a user with OpenID Connect

Get an unsplash image

Search for a background from unsplash

Creates a new saved filter

GET STARTED

Start building with Vikunja API

Explore with Jentic One

View OpenAPI Document

Use Cases

Patterns agents use Vikunja API for, with concrete tasks.

★ Identity and Authentication Operations

Use the Vikunja API to perform identity auth operations programmatically. The API provides 153 endpoints covering core functionality including authenticate a user with openid connect, get an unsplash image, get an unsplash thumbnail image.

Call POST /auth/openid/{provider}/callback to authenticate a user with openid connect

Automated Auth Management

Automate auth operations by combining multiple Vikunja API endpoints. Agents can get an unsplash image and then get an unsplash thumbnail image in a single workflow.

Call GET /backgrounds/unsplash/image/{image} to get an unsplash image, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Vikunja API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, basic tokens manually.

Search Jentic for 'authenticate a user with openid connect', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

153 endpoints — pagination every endpoint capable of pagination will return two headers: * `x-pagination-total-pages`: the total number of available pages for this request * `x-pagination-result-count`: the number of items returned for this request.

METHOD

PATH

DESCRIPTION

POST

/auth/openid/{provider}/callback

Authenticate a user with OpenID Connect

GET

/backgrounds/unsplash/image/{image}

Get an unsplash image

GET

/backgrounds/unsplash/image/{image}/thumb

Get an unsplash thumbnail image

GET

/backgrounds/unsplash/search

Search for a background from unsplash

PUT

/filters

Creates a new saved filter

POST

/filters/{id}

Updates a saved filter

GET

/filters/{id}

Gets one saved filter

DELETE

/filters/{id}

Removes a saved filter

POST

/auth/openid/{provider}/callback

Authenticate a user with OpenID Connect

GET

/backgrounds/unsplash/image/{image}

Get an unsplash image

GET

/backgrounds/unsplash/image/{image}/thumb

Get an unsplash thumbnail image

GET

/backgrounds/unsplash/search

Search for a background from unsplash

PUT

/filters

Creates a new saved filter

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the Vikunja API by hand means choosing between its basic auth and its JWT Authorization header and threading tokens through its large task and filter surface yourself. Through Jentic you install once, import the Vikunja API from the API Directory, store the credential once, and your agent calls it.

Permission scoping

Vikunja puts the filter id in the URL path (/filters/{id}), so a rule can pin your agent to one filter and the operations around it. You choose the operations it may call, so a destructive one like deleting a filter is not included unless you add it.

Credential isolation

Your Vikunja credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a saved filter' or 'search Unsplash backgrounds', and Jentic returns the matching Vikunja operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using Vikunja API through Jentic.

What authentication does the Vikunja API use?

The Vikunja API uses apiKey, basic authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

Can I authenticate a user with openid connect with the Vikunja API?

Yes. Use the POST /auth/openid/{provider}/callback endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Vikunja API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

How do I authenticate a user with openid connect through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'authenticate a user with openid connect'. Jentic returns the matching Vikunja API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

How many endpoints does the Vikunja API have?

The Vikunja API exposes 153 endpoints covering auth, avatar, backgrounds operations.

Vikunja API

Connect the Vikunja API to your agent

Capabilities

Start building with Vikunja API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs