canonical: https://jentic.com/apis/thejqapi.com/thejqapi

# Thejqapi JQ API

JQ API for processing JSON data using jq filter expressions. The API exposes 1 endpoints secured with bearer authentication.

## For AI agents

Programmatically process json data using jq filter. Covers 1 operations with bearer authentication.

## Scope

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

## Capabilities

- Process JSON data using jq filter
- Manage data enrichment data programmatically
- Integrate JQ API into automated workflows
- Query and filter JQ API records by parameters
- Monitor JQ API operational status and events

## Use cases

### Data Enrichment Operations

Use the JQ API to perform data enrichment operations programmatically. The API provides 1 endpoints covering core functionality including process json data using jq filter.

Example prompt: Call POST /process to process json data using jq filter

### Data Retrieval and Monitoring

Query JQ API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary JQ API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

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

Example prompt: Search Jentic for 'process json data using jq filter', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/process` | Process JSON data using jq filter |

## Key resources

- **Processing** — Operations related to Processing

## 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:** 67 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/thejqapi.com/thejqapi/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 JQ API by hand means learning its bearer auth against thejqapi.com and posting your data and jq filter to its single processing endpoint yourself. Through Jentic you install once, import the JQ API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** The JQ API exposes a single processing operation at /process, so you limit the agent to just that operation and nothing else. Because that is the only call you grant, the agent can transform JSON with a jq filter but cannot reach any other functionality.
- **Credential handling:** Your JQ API token 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 'process JSON data using a jq filter', and Jentic returns the matching JQ API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Clearbit** — Alternative data enrichment API
- **Fullcontact** — Alternative data enrichment API
- **Hunter** — Complementary data enrichment API

## FAQ

### What authentication does the JQ API use?

The JQ API uses a Bearer token in the Authorization header. 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 process json data using jq filter with the JQ API?

Yes. Use the POST /process endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the JQ 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 process json data using jq filter through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'process json data using jq filter'. Jentic returns the matching JQ API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

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

The JQ API exposes 1 endpoints covering processing operations.

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

Yes. The JQ API exposes a single processing operation at POST /process, and because Jentic One is self-hosted, you set the rules that decide which operations and credentials your agent may use. You can grant the agent only that one operation, so it can transform JSON with a jq filter but cannot reach anything else. Your bearer token stays with your own Jentic One instance and is injected at execution time rather than exposed to the agent.