Code Climate Quality API

Name: Code Climate Quality API
Brand: Code Climate Quality API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsTesting Qabearer8 EndpointsREST

For Agents

Read code quality signals — issues, project metrics, and file metrics — for repositories analysed by Code Climate (Qlty), authenticated with a Bearer token.

Install Jentic One Beta

Connect the Code Climate Quality API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Code Climate Quality 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://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | 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 Code Climate Quality API.

List every Qlty workspace the authenticated user can access via GET /workspaces

Enumerate the projects under a GitHub owner with GET /gh/{ownerKeyOrId}/projects

Retrieve aggregate quality metrics for a project via GET /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/metrics

GET STARTED

Start building with Code Climate Quality API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Code Climate Quality API, keeping it validated and agent-ready. Code Climate (now operating as Qlty) is a code quality and maintainability platform that analyses repositories for issues, complexity, duplication, and technical debt. The Quality API exposes 8 read-oriented endpoints over the api.qlty.sh host, covering workspaces, projects, issues, project metrics, and file-level metrics. Authentication is a Bearer token tied to a Qlty user, so agents can pull quality signals into dashboards, pull request automation, or risk reports without scraping the web UI.

Use Cases

Patterns agents use Code Climate Quality API for, with concrete tasks.

★ Pull Request Quality Gating

Read Code Climate issues for a project as part of a pull request review pipeline so the reviewing agent can flag any newly introduced quality regressions. The agent calls GET /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues, diffs against the base branch, and posts a structured comment. Helps engineering leaders enforce a quality bar without manual triage.

Call GET /gh/acme/projects/web-app/issues, filter to issues touching files in the PR diff, and post a summary comment listing each issue with its severity

Engineering Metrics Dashboards

Pull project-level and file-level metrics across an entire engineering portfolio for a leadership dashboard. The API supports per-project metrics and per-file breakdowns so a dashboard can answer 'where is our technical debt concentrated?' without each team having to surface the data manually. Updates run on a schedule rather than ad hoc.

For every project under owner 'acme' fetch GET /gh/acme/projects/{projectKeyOrId}/metrics and POST the results to a Looker datasource

Hotspot Discovery for Refactoring Sprints

Identify the files with the highest complexity and most outstanding issues so a refactoring sprint can target the right code. The file metrics endpoint returns per-file scores, which the agent can rank to produce a prioritised list. Replaces gut-feel decisions about what to refactor with data from the same engine that scored every recent commit.

Call GET /gh/acme/projects/web-app/files, sort by complexity descending, and produce a top-10 list with file path, complexity score, and open issue count

Workspace Onboarding Audits

When a new team joins Qlty, audit which workspaces and projects are visible, then verify that every active GitHub repository has an associated Qlty project. The agent enumerates GET /workspaces and GET /gh/{ownerKeyOrId}/projects and reconciles against the GitHub API to flag missing coverage. Catches blind spots before they show up in a board review.

List all workspaces with GET /workspaces, list projects per owner with GET /gh/{ownerKeyOrId}/projects, then list repos via the GitHub API and report repositories without a matching Qlty project

Agent-Driven Quality Lookups via Jentic

A Jentic-connected agent can answer ad hoc questions like 'how bad is the quality of our payments service right now?' by issuing the right Code Climate Quality API call and summarising the response. Jentic stores the Bearer token in its vault so the agent never receives the raw secret. The whole loop — search, load, execute, summarise — runs in seconds.

Search Jentic for 'get Code Climate project metrics', load the schema, execute against project 'payments-service', and return a one-paragraph quality summary

Key Endpoints

8 endpoints — jentic publishes the only available openapi specification for code climate quality api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/workspaces

List Qlty workspaces

GET

/workspaces/{keyOrId}

Retrieve a single workspace

GET

/gh/{ownerKeyOrId}/projects

List projects under a GitHub owner

GET

/gh/{ownerKeyOrId}/projects/{keyOrId}

Retrieve a single project

GET

/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues

List open code quality issues for a project

GET

/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/metrics

Get aggregate metrics for a project

GET

/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/files

Get per-file metrics

GET

/user

Get the authenticated user

GET

/workspaces

List Qlty workspaces

GET

/workspaces/{keyOrId}

Retrieve a single workspace

GET

/gh/{ownerKeyOrId}/projects

List projects under a GitHub owner

GET

/gh/{ownerKeyOrId}/projects/{keyOrId}

Retrieve a single project

GET

/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues

List open code quality issues for a project

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Code Climate Quality API Bearer token is stored encrypted in the Jentic vault. Agents receive scoped access; the raw token never enters the agent's context or appears in logs.

Intent-based discovery

Agents search Jentic by intent (e.g., 'get code quality issues for a project') and Jentic returns the matching operation with parameter schema, so the agent can call /gh/{owner}/projects/{project}/issues without scraping vendor docs.

Time to first call

Direct Code Climate Quality API integration: half a day to model resources and wire Bearer auth. Through Jentic: under 20 minutes — search, load, execute.

FAQs

Specific to using Code Climate Quality API through Jentic.

Why is there no official OpenAPI spec for Code Climate Quality API?

Code Climate (Qlty) does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Code Climate Quality API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Code Climate Quality API use?

The Code Climate Quality API uses HTTP Bearer authentication. You generate a token in the Qlty account UI and send it as Authorization: Bearer {token}. Through Jentic the token is stored in the vault, and agents receive scoped execution access only.

Can I list code quality issues for a repository with the Code Climate Quality API?

Yes. Call GET /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues with the GitHub owner key and project key. The endpoint returns the open issues detected by the Qlty engine, which agents can rank by severity or filter to a specific file path.

What are the rate limits for the Code Climate Quality API?

Qlty does not publish a public rate limit in its API documentation. Treat the API as best-effort and back off on HTTP 429 responses. For portfolio-wide metric pulls, throttle to a few requests per second per token.

How do I get project metrics through Jentic?

Search Jentic for 'get Code Climate project metrics', load the schema for GET /gh/{ownerKeyOrId}/projects/{projectKeyOrId}/metrics, and execute it with the relevant owner and project keys. Jentic injects the Bearer token from the vault and returns the parsed metrics object.

Does the Code Climate Quality API support write operations?

Not in this spec. The 8 documented endpoints are all GET requests covering workspaces, projects, issues, metrics, and the authenticated user. Configuration changes still happen in the Qlty UI.