canonical: https://jentic.com/apis/qliq.cloud/qliq

# Qliq Contaqt API

Contaqt marketing API for managing articles, mailing list subscribers, and automation flows. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically validate API key, get articles. Covers 5 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- Validate API key
- Get articles
- Add subscriber
- Remove subscriber
- Start automation flow

## Use cases

### Marketing Operations

Use the Contaqt API to perform marketing operations programmatically. The API provides 5 endpoints covering core functionality including validate API key, get articles, add subscriber.

Example prompt: Call POST `/apis/checking-api-key` to validate API key

### Automated Articles Management

Automate articles operations by combining multiple Contaqt API endpoints. Agents can get articles and then add subscriber in a single workflow.

Example prompt: Call POST `/articles/get-v2` to get articles, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Contaqt 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 tokens manually.

Example prompt: Search Jentic for 'validate API key', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/apis/checking-api-key` | Validate API key |
| POST | `/articles/get-v2` | Get articles |
| POST | `/articles/add-subscriber-v2` | Add subscriber |
| POST | `/articles/remove-subscriber-v2` | Remove subscriber |
| POST | `/apis/start-flow` | Start automation flow |

## Key resources

- **Articles** — Operations related to Articles
- **Authentication** — Operations related to Authentication
- **Flows** — Operations related to Flows
- **Subscribers** — Operations related to Subscribers

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 49 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 54 / 100
  - Agent Usability: 94 / 100
  - Security: 15 / 100
  - AI Discoverability: 85 / 100
- **View full report:** https://jentic.com/apis/qliq.cloud/qliq/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Contaqt API by hand means passing your api_key on every query string and posting each article and flow call yourself. Through Jentic you install once, import the Contaqt API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Contaqt takes its article and subscriber details in the request body rather than as path resources, so scope the agent to the operations it needs, such as adding a subscriber or fetching articles. You choose that allowed set, so removing a subscriber or starting a flow is not included unless you add it.
- **Credential handling:** Your Contaqt key 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.
- **Discovery method:** Agents search Jentic by intent such as 'validate an API key' or 'add a subscriber to an article', and Jentic returns the matching Contaqt operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the Contaqt API use?

The Contaqt API uses an API key passed in the `api_key` query. 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 validate API key with the Contaqt API?

Yes. Use the POST `/apis/checking-api-key` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Contaqt 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 validate API key through Jentic?

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

### How many endpoints does the Contaqt API have?

The Contaqt API exposes 5 endpoints covering articles, authentication, flows operations.

### Can I limit what my agent is allowed to do with the Contaqt API?

Yes. Because you run Jentic One yourself, your own rules decide which Contaqt operations and credentials the agent may use, so you grant only the calls it needs, such as fetching articles or adding a subscriber, while leaving out removing a subscriber or starting an automation flow. Contaqt takes its article and subscriber details in the request body rather than as path resources, so scoping is done at the operation level rather than per record. Your API key is stored encrypted by your Jentic One instance and injected only when an allowed operation runs, so it never enters the agent's prompt or logs.