CircleCI

CircleCI is a continuous integration and continuous delivery (CI/CD) platform that automates software build, test, and deployment pipelines. Their developer surface includes the REST API v2 (the recommended modern interface), the legacy v1 REST API, a Self-Hosted Runner API, webhooks for real-time event notifications, and the Orbs Registry of reusable configuration packages. Authentication is via a personal or project Circle-Token sent in the Circle-Token header; responses are JSON.

CircleCI publishes 18 API contracts indexed on the APIs.io network, including Self-Hosted Runner API, Webhooks, Artifact API, and 15 more. Tagged areas include CI/CD, Continuous Integration, Continuous Deployment, DevOps, and Pipelines.

The CircleCI catalog on APIs.io includes 2 event-driven AsyncAPI specifications, 1 JSON-LD context, and 3 Spectral governance rulesets.

CircleCI’s developer surface includes CLI, changelog, pricing, API reference, authentication, developer portal, documentation, and 45 more developer resources.

🌐 Visit website 📡 Profile data on GitHub

69.1/100 exemplar ▬ flat Agent 56/100 agent ready Front door AI 6/6 dominant Heartbeat 90/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →

AccessFreemiumSelf serve⚡ Free to try

3 published contracts 1 MCP Servers 3 Agent Skills 16 Features

CI/CD Continuous Integration Continuous Deployment DevOps Pipelines Workflows Developer Tools

What this lets a business do 5

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

Software Release & Deployment Management

BC-4210

ArtifactBuildConfigsContextContextsDeploy Components

POST /project/{vcs-type}/{username}/{project} POST /project/{vcs-type}/{username}/{project}/{build_num}/retry POST /project/{vcs-type}/{username}/{project}/{build_num}/cancel POST /project/{project-slug}/pipeline

Software Product Engineering Management

BC-4200

InsightsTest FlakesTest MetadataTest Results

GET /project/{vcs-type}/{username}/{project}/{build_num}/tests

Developer Platform & API Ecosystem Management

BC-4270

WebhookWebhooks

Open Source Ecosystem

AE-250

Orb PackagesOrb Versions

Cybersecurity Management

BC-620

Groups

Kin Score

Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0

Composite quality — 69.1/100 · exemplar

Contract Quality 13.7 / 19

Developer Ergonomics 8.8 / 15

Access Clarity 12.6 / 15

Operational Transparency 4.6 / 10

Contract Governance 2.9 / 9

Discoverability 6.1 / 8

Regulatory Posture 4.9 / 15

Create-or-Update Ergonomics 2.2 / 10

Agent readiness — 56/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

Documented Reversibility 6 / 6

MCP Server 12 / 12

Machine-Readable Auth 10 / 10

Idempotency 0 / 9

Stable Error Semantics 8 / 8

Request/Response Examples 0 / 7

Rate-Limit Signaling 7 / 7

Typed Event Surface 6 / 6

Agent Skills 5 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Delegated User Identity 6 / 6

Protected Resource Metadata 5 / 5

Registration Without a Human 6 / 6

Agentic Commerce Well-Known Document 0 / 5

Pagination 5 / 5

Distinct Operations 3 / 3

MCP Tool Quality 6 / 6

Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.

Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.

The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.

Show this score on your site.

It updates itself when the score changes. Paste this where you link to your API docs:

<a href="https://apis.io/providers/circleci/"><img src="https://apis.io/badge/circleci/card.svg" alt="CircleCI on APIs.io — Kin Score by API Evangelist"></a>

Other styles, a README pill and a shields.io endpoint are on the badge page.

Raise your score.

Agent readiness — checks not met, largest first (exact, from this profile):

Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
Request/Response Examples +7 pts — share of operations carrying request/response examples; else an Examples / Code Samples link
Agentic Commerce Well-Known Document +5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's
Dry-Run / Simulate Mode +4 pts — OpenAPI: destructive operations expose a dry_run / simulate / preview / validate_only parameter
Well-Known Catalog +4 pts — common[].type includes WellKnown, APICatalog, or api-catalog

1 more unmet check in the Agent Readiness table above.

Kin Score — facets with the most composite points still available (weight × headroom):

Developer Ergonomics scores 58.9 — up to +8.2 composite points
Contract Governance scores 31.8 — up to +8.2 composite points
Operational Transparency scores 47.4 — up to +6.8 composite points

Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/circleci/apis.yml: open an issue on github.com/api-evangelist/circleci to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

Market	Position	Depth	Registered MCP server	Declares compatibility
Developer Tools	builds-on	53.0	1	2
IDE Extension Marketplaces (JetBrains, VS Code, Open VSX, Docker Verified Publishers, PyPI orgs)	builds-on	53.0	1	2
Accelerator Portfolios (Y Combinator, 500 Global, Antler participation)	builds-on	53.0	1	2
Backstage Plugin Directory	builds-on	53.0	1	2
Raycast Store Extensions (first-party publishers + community-wrapped products)	builds-on	53.0	1	2
Jenkins Plugins + CD Foundation Landscape	builds-on	53.0	1	2
APIs.guru OpenAPI Directory (API definition directory)	builds-on	53.0	1	2
Docker Hub Verified Publishers + Official Images	builds-on	53.0	1	2

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 5

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

Model Context Protocol (MCP)

measured — observed by APIs.io (verified)

OAuth 2.0 Protected Resource Metadata

measured — observed by APIs.io (verified)

Dynamic Client Registration

measured — observed by APIs.io (published)

OpenAPI

measured — observed by APIs.io (published)

AsyncAPI

measured — observed by APIs.io (published)

APIs 18

Individual APIs this provider publishes, each with its own machine-readable definition.

CircleCI Self-Hosted Runner API

The CircleCI Self-Hosted Runner API enables management and execution of jobs on self-hosted runner infrastructure. It provides endpoints for listing available runners, managing ...

CircleCI Webhooks

CircleCI Webhooks allow developers to receive real-time notifications about events in their CI/CD pipelines by configuring HTTP callbacks. Webhooks can be set up through project...

CircleCI Orbs Registry

CircleCI Orbs are shareable, reusable packages of CircleCI configuration that simplify build setup and integration with third-party tools. The Orbs Registry on the CircleCI Deve...

CircleCI Artifact API

Endpoints for listing and downloading build artifacts.

CircleCI Build API

Endpoints for retrieving build details, triggering builds, retrying builds, and canceling builds.

CircleCI Context API

Endpoints for managing contexts, which are used to secure and share environment variables across projects.

CircleCI Insights API

Endpoints for retrieving workflow and job metrics, summary data, and test performance insights.

CircleCI Job API

Endpoints for retrieving job details, artifacts, and test metadata associated with pipeline jobs.

CircleCI Pipeline API

Endpoints for triggering, retrieving, and managing pipelines and their configurations.

CircleCI Project API

Endpoints for listing followed projects and managing project settings.

CircleCI Resource Class API

Endpoints for managing runner resource classes, which define the compute resources available for self-hosted runner jobs.

CircleCI Runner Task API

Endpoints for querying task counts and managing tasks assigned to self-hosted runners.

CircleCI Schedule API

Endpoints for creating, updating, and managing scheduled pipeline triggers.

CircleCI SSH Key API

Endpoints for managing SSH keys and checkout keys for projects.

CircleCI Test Metadata API

Endpoints for retrieving test metadata collected during builds.

CircleCI User API

Endpoints for retrieving information about the authenticated user.

CircleCI Webhook API

Endpoints for creating, updating, listing, and deleting outbound webhook subscriptions.

CircleCI Workflow API

Endpoints for retrieving workflow details, managing workflow status, and rerunning workflows.

Scroll for all 18

CircleCI REST API v1 Artifact Workflow API

POSTMAN

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

CircleCI MCP Server

Remote MCP server at mcp.circleci.com over HTTP.

Plan details, limits and sources →

Rate limits

REST API v2: 3000 requests per minute
Webhook deliveries: 100 deliveries per second
Build concurrency (Free): 30 concurrent builds

Compiled by API Evangelist, not yet checked against CircleCI's documentation. All 4 limits →

Billed by: subscription · FinOps profile →

Pricing Plans 2

Published pricing tiers and plan structures.

Circleci Plans Pricing

3 plans

PLANS

Circleci Price Estimates

0 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Circleci Rate Limits

4 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

CircleCI

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Circleci Finops

FINOPS

Features 16

Notable capabilities this provider offers.

Free: 30K credits/mo, 6K build minutes, 5 active users

Performance from $15/mo: 30K credits + $15/25K credits, 80x concurrency

Scale: custom annual, 200 GB storage, GPU, SSO, config policies

REST API v2 at circleci.com/api/v2

Default 3,000 req/min API rate limit

Self-hosted runners (Linux, Windows, macOS, Arm)

Docker layer caching (Performance+)

Orbs marketplace for reusable config

Webhooks for pipeline events

OAuth 2.0 + personal API tokens

Test splitting and parallel execution

GPU executors (Scale)

Insights API for build analytics

OIDC token federation for cloud auth

Config policies for governance (Scale)

SOC 2, FedRAMP Moderate (Scale)

Scroll for all 16

Event Specifications 2

AsyncAPI definitions for this provider's event-driven and streaming APIs.

CircleCI Webhooks

CircleCI Webhooks allow developers to receive real-time notifications about events in their CI/CD pipelines by configuring HTTP callbacks. Webhooks can be set up through project...

ASYNCAPI

Circleci Webhooks

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Circleci Context

0 classes · 10 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

CircleCI — asyncapi rules

5 rules · 1 errors 4 warnings

SPECTRAL

CircleCI — jsonschema rules

6 rules · 5 warnings 1 info

SPECTRAL

CircleCI API Rules

10 rules · 4 errors 5 warnings 1 info

SPECTRAL

OpenAPI Overlays 1

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Circleci Artifact Api Overlay

0 actions · update

DERIVED

8 properties

JSON SCHEMA

WorkflowJobList

2 properties

JSON SCHEMA

WorkflowList

2 properties

JSON SCHEMA

Scroll for all 83

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Circleci Structure

0 properties

JSON STRUCTURE

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Circleci Authentication

apiKey/http · 3 schemes

SECURITY

Circleci Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Circleci Vulnerability Disclosure

security.txt · contact published

SECURITY

Circleci Trust Center

SOC 2, FedRAMP, GDPR, CSA STAR

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Circleci Agentic Access

74 operations · 30 acting

AGENTIC

Resources

Get Started 2

Portal, sign-up, and the first successful call

Portal

Portal

Login

Documentation 5

Reference material describing how the API behaves

APIReference

Documentation

JSONSchema

JSONSchema

JSONSchema

Agent Surfaces 6

MCP servers, agent skills, and machine-readable catalogs

AgentSkill

LLMsTxt

MCPServer

WellKnown

AgenticAccess

LlmsText

Design & Contract 10

Pagination, idempotency, versioning, errors, and events

Spectral

Spectral

Vocabulary

Webhooks

Webhooks

DataModel

ErrorCatalog

Conformance

JSONLD

Spectral

Scroll for all 10

Build 5

SDKs, sample code, and the tooling you integrate with

CLI

SDKs

Packages

PostmanWorkspace

GitHubOrganization

GitHubOrganization

Access & Security 6

Authentication, authorization, and security posture

Compliance

Compliance

Security

Security

TrustCenter

TrustCenter

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 5

Status, limits, changes, and where to get help

RateLimits

ChangeLog

ChangeLog

StatusPage

Support

Commercial 5

Pricing, plans, and the legal terms of use

FinOps

Plans

Pricing

PrivacyPolicy

TermsOfService

Company 4

The organization behind the API

Newsroom

Newsroom

LinkedIn

Website

Website

Blog

Blog

Other 4

Properties that don't map to a standard resource type

Overlay

Hosts

Vendors

CapabilityMap

Source (apis.yml)

aid: circleci
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/circleci.png
name: CircleCI
url: https://raw.githubusercontent.com/api-evangelist/circleci/refs/heads/main/apis.yml
created: '2025-03-05'
modified: '2026-09-16'
type: Index
access: 3rd-Party
position: Consuming
specificationVersion: '0.23'
tags:
- CI/CD
- Continuous Integration
- Continuous Deployment
- DevOps
- Pipelines
- Workflows
- Developer Tools
description: CircleCI is a continuous integration and continuous delivery (CI/CD) platform that automates software build,
  test, and deployment pipelines. Their developer surface includes the REST API v2 (the recommended modern interface), the
  legacy v1 REST API, a Self-Hosted Runner API, webhooks for real-time event notifications, and the Orbs Registry of reusable
  configuration packages. Authentication is via a personal or project Circle-Token sent in the Circle-Token header; responses
  are JSON.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
common:
- type: FinOps
  url: finops/circleci-finops.yml
- type: RateLimits
  url: rate-limits/circleci-rate-limits.yml
- type: Plans
  url: plans/circleci-plans-pricing.yml
- type: Spectral
  url: rules/circleci-jsonschema-spectral-rules.yml
- type: Spectral
  url: rules/circleci-asyncapi-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/circleci-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Webhooks
  url: asyncapi/circleci-webhooks.yml
- type: Webhooks
  url: asyncapi/circleci-webhooks-asyncapi.yml
- type: DataModel
  url: data-model/circleci-data-model.yml
- type: CLI
  url: cli/circleci-cli.yml
- type: ChangeLog
  url: changelog/circleci-changelog.yml
- type: Compliance
  url: https://trust.circleci.com/
- type: ErrorCatalog
  url: errors/circleci-problem-types.yml
- type: Conformance
  url: conformance/circleci-conformance.yml
- type: Overlay
  url: overlays/circleci-artifact-api-overlay.yml
- type: LLMsTxt
  url: llms/circleci-llms.txt
- type: MCPServer
  url: mcp/circleci-mcp.yml
- type: WellKnown
  url: well-known/circleci-well-known.yml
- type: Hosts
  url: hosts/circleci-hosts.yml
- type: Vendors
  url: vendors/circleci-vendors.yml
- type: SDKs
  url: packages/circleci-packages.yml
- type: Packages
  url: packages/circleci-packages.yml
- type: Security
  url: https://circleci.com/security/
- type: Pricing
  url: https://circleci.com/pricing/
- type: Newsroom
  url: https://circleci.com/newsroom/
- type: ChangeLog
  url: https://circleci.com/changelog/
- type: APIReference
  url: https://circleci.com/docs/guides/getting-started/getting-started/
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/circleci/overview
- type: AgenticAccess
  url: agentic-access/circleci-agentic-access.yml
- type: TrustCenter
  url: security/circleci-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/circleci-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/circleci-domain-security.yml
- type: Authentication
  url: authentication/circleci-authentication.yml
- type: GitHubOrganization
  url: https://github.com/circleci
- type: LinkedIn
  url: https://www.linkedin.com/company/circleci
- type: Website
  url: https://circleci.com/
- type: Portal
  url: https://circleci.com/developer
- type: Documentation
  url: https://circleci.com/docs/
- type: StatusPage
  url: https://status.circleci.com/
- type: Support
  url: https://support.circleci.com/
- type: Blog
  url: https://circleci.com/blog/
- type: PrivacyPolicy
  url: https://circleci.com/privacy/
- type: TermsOfService
  url: https://circleci.com/terms-of-service/
- type: Login
  url: https://app.circleci.com/
- type: JSONLD
  url: json-ld/circleci-context.jsonld
- type: JSONSchema
  url: json-schema/circleci-pipeline-schema.json
- type: JSONSchema
  url: json-schema/circleci-workflow-schema.json
- type: JSONSchema
  url: json-schema/circleci-webhook-event-schema.json
- type: Spectral
  url: rules/circleci-rules.yml
- type: Features
  data:
  - 'Free: 30K credits/mo, 6K build minutes, 5 active users'
  - 'Performance from $15/mo: 30K credits + $15/25K credits, 80x concurrency'
  - 'Scale: custom annual, 200 GB storage, GPU, SSO, config policies'
  - REST API v2 at circleci.com/api/v2
  - Default 3,000 req/min API rate limit
  - Self-hosted runners (Linux, Windows, macOS, Arm)
  - Docker layer caching (Performance+)
  - Orbs marketplace for reusable config
  - Webhooks for pipeline events
  - OAuth 2.0 + personal API tokens
  - Test splitting and parallel execution
  - GPU executors (Scale)
  - Insights API for build analytics
  - OIDC token federation for cloud auth
  - Config policies for governance (Scale)
  - SOC 2, FedRAMP Moderate (Scale)
  sources:
  - https://circleci.com/pricing/
  updated: '2026-05-04'
- type: Integrations
  url: https://circleci.com/integrations/
- type: LlmsText
  url: https://circleci.com/llms.txt
- type: CapabilityMap
  url: capabilities/circleci-capability-edges.yml
  name: CircleCI Business Capability Map
apis:
- aid: circleci:runner-api
  name: CircleCI Self-Hosted Runner API
  tags:
  - CI/CD
  - Infrastructure
  - Runners
  - Self-Hosted
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  baseURL: https://runner.circleci.com
  humanURL: https://circleci.com/docs/runner-api/
  properties:
  - url: https://circleci.com/docs/runner-api/
    type: Documentation
  - url: openapi/circleci-runner-api-openapi.yml
    type: OpenAPI
  - type: JSONSchema
    url: json-schema/circleci-runner-schema.json
  description: The CircleCI Self-Hosted Runner API enables management and execution of jobs on self-hosted runner infrastructure.
    It provides endpoints for listing available runners, managing runner tasks, and querying resource classes. The API is
    hosted separately from the main CircleCI API at runner.circleci.com and supports multiple authentication methods depending
    on the endpoint. Developers can use this API to integrate self-hosted runner management into their infrastructure automation
    workflows.
- aid: circleci:webhooks
  name: CircleCI Webhooks
  tags:
  - CI/CD
  - Event
  - Notification
  - Webhook
  tags_raw:
  - CI/CD
  - Events
  - Notifications
  - Webhooks
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  baseURL: https://api.example.com
  humanURL: https://circleci.com/docs/webhooks/
  properties:
  - url: https://circleci.com/docs/webhooks/
    type: Documentation
  - url: asyncapi/circleci-webhooks-asyncapi.yml
    type: AsyncAPI
  description: CircleCI Webhooks allow developers to receive real-time notifications about events in their CI/CD pipelines
    by configuring HTTP callbacks. Webhooks can be set up through project settings to notify external services when workflows
    and jobs complete, fail, or change status. This enables integration with monitoring systems, chat platforms, and custom
    automation workflows. Webhooks deliver JSON payloads containing event details to configured endpoint URLs.
- aid: circleci:orbs
  name: CircleCI Orbs Registry
  tags:
  - CI/CD
  - Configuration
  - Packages
  - Reusable
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  baseURL: https://api.example.com
  humanURL: https://circleci.com/developer/orbs
  properties:
  - url: https://circleci.com/developer/orbs
    type: Documentation
  description: CircleCI Orbs are shareable, reusable packages of CircleCI configuration that simplify build setup and integration
    with third-party tools. The Orbs Registry on the CircleCI Developer Hub provides a searchable catalog of community and
    certified orbs. Developers can browse, publish, and consume orbs to automate repeated processes, speed up project configuration,
    and integrate services like AWS, Docker, Slack, and Kubernetes into their CI/CD pipelines.
- aid: circleci:circleci-artifact-api
  name: CircleCI Artifact API
  description: Endpoints for listing and downloading build artifacts.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Artifact
  properties:
  - type: OpenAPI
    url: openapi/circleci-artifact-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-artifact-schema.json
- aid: circleci:circleci-build-api
  name: CircleCI Build API
  description: Endpoints for retrieving build details, triggering builds, retrying builds, and canceling builds.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Builds
  tags_raw:
  - Build
  properties:
  - type: OpenAPI
    url: openapi/circleci-build-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-build-schema.json
  - type: JSONSchema
    url: json-schema/circleci-build-detail-schema.json
  - type: JSONSchema
    url: json-schema/circleci-build-summary-schema.json
- aid: circleci:circleci-context-api
  name: CircleCI Context API
  description: Endpoints for managing contexts, which are used to secure and share environment variables across projects.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Context
  properties:
  - type: OpenAPI
    url: openapi/circleci-context-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-environment-variable-schema.json
  - type: JSONSchema
    url: json-schema/circleci-create-context-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-context-schema.json
  - type: JSONSchema
    url: json-schema/circleci-environment-variable-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-context-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-message-response-schema.json
- aid: circleci:circleci-insights-api
  name: CircleCI Insights API
  description: Endpoints for retrieving workflow and job metrics, summary data, and test performance insights.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Insights
  properties:
  - type: OpenAPI
    url: openapi/circleci-insights-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-insights-test-metrics-schema.json
  - type: JSONSchema
    url: json-schema/circleci-insights-workflow-metrics-schema.json
  - type: JSONSchema
    url: json-schema/circleci-insights-job-metrics-schema.json
  - type: JSONSchema
    url: json-schema/circleci-insights-workflow-runs-schema.json
- aid: circleci:circleci-job-api
  name: CircleCI Job API
  description: Endpoints for retrieving job details, artifacts, and test metadata associated with pipeline jobs.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Job
  properties:
  - type: OpenAPI
    url: openapi/circleci-job-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-job-schema.json
  - type: JSONSchema
    url: json-schema/circleci-test-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-artifact-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-message-response-schema.json
- aid: circleci:circleci-pipeline-api
  name: CircleCI Pipeline API
  description: Endpoints for triggering, retrieving, and managing pipelines and their configurations.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Pipelines
  tags_raw:
  - Pipeline
  properties:
  - type: OpenAPI
    url: openapi/circleci-pipeline-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-pipeline-schema.json
  - type: JSONSchema
    url: json-schema/circleci-pipeline-creation-schema.json
  - type: JSONSchema
    url: json-schema/circleci-pipeline-config-schema.json
  - type: JSONSchema
    url: json-schema/circleci-trigger-pipeline-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-pipeline-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-workflow-list-schema.json
- aid: circleci:circleci-project-api
  name: CircleCI Project API
  description: Endpoints for listing followed projects and managing project settings.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Project
  properties:
  - type: OpenAPI
    url: openapi/circleci-project-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-project-2-schema.json
  - type: JSONSchema
    url: json-schema/circleci-project-schema.json
  - type: JSONSchema
    url: json-schema/circleci-checkout-key-schema.json
  - type: JSONSchema
    url: json-schema/circleci-build-summary-schema.json
  - type: JSONSchema
    url: json-schema/circleci-project-env-var-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-checkout-key-list-schema.json
- aid: circleci:circleci-resource-class-api
  name: CircleCI Resource Class API
  description: Endpoints for managing runner resource classes, which define the compute resources available for self-hosted
    runner jobs.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Resource Class
  properties:
  - type: OpenAPI
    url: openapi/circleci-resource-class-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-resource-class-creation-schema.json
  - type: JSONSchema
    url: json-schema/circleci-resource-class-schema.json
- aid: circleci:circleci-runner-task-api
  name: CircleCI Runner Task API
  description: Endpoints for querying task counts and managing tasks assigned to self-hosted runners.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Runner Task
  properties:
  - type: OpenAPI
    url: openapi/circleci-runner-task-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
- aid: circleci:circleci-schedule-api
  name: CircleCI Schedule API
  description: Endpoints for creating, updating, and managing scheduled pipeline triggers.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Schedule
  properties:
  - type: OpenAPI
    url: openapi/circleci-schedule-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-schedule-schema.json
  - type: JSONSchema
    url: json-schema/circleci-create-schedule-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-update-schedule-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-schedule-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-message-response-schema.json
- aid: circleci:circleci-ssh-key-api
  name: CircleCI SSH Key API
  description: Endpoints for managing SSH keys and checkout keys for projects.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - SSH Key
  properties:
  - type: OpenAPI
    url: openapi/circleci-ssh-key-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-checkout-key-schema.json
- aid: circleci:circleci-test-metadata-api
  name: CircleCI Test Metadata API
  description: Endpoints for retrieving test metadata collected during builds.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Test Metadata
  properties:
  - type: OpenAPI
    url: openapi/circleci-test-metadata-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-test-metadata-schema.json
- aid: circleci:circleci-user-api
  name: CircleCI User API
  description: Endpoints for retrieving information about the authenticated user.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - User
  properties:
  - type: OpenAPI
    url: openapi/circleci-user-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-user-schema.json
  - type: JSONSchema
    url: json-schema/circleci-collaboration-schema.json
- aid: circleci:circleci-webhook-api
  name: CircleCI Webhook API
  description: Endpoints for creating, updating, listing, and deleting outbound webhook subscriptions.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Webhook
  properties:
  - type: OpenAPI
    url: openapi/circleci-webhook-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-webhook-info-schema.json
  - type: JSONSchema
    url: json-schema/circleci-create-webhook-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-update-webhook-request-schema.json
  - type: JSONSchema
    url: json-schema/circleci-webhook-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-message-response-schema.json
- aid: circleci:circleci-workflow-api
  name: CircleCI Workflow API
  description: Endpoints for retrieving workflow details, managing workflow status, and rerunning workflows.
  humanURL: https://circleci.com/docs/api/v2/
  baseURL: https://circleci.com/api/v2
  tags:
  - Workflows
  tags_raw:
  - Workflow
  properties:
  - type: OpenAPI
    url: openapi/circleci-workflow-api-openapi.yml
  - type: Documentation
    url: https://circleci.com/docs/api/v2/
  - type: Documentation
    url: https://circleci.com/docs/api/v1/
  - type: JSONSchema
    url: json-schema/circleci-workflow-schema.json
  - type: JSONSchema
    url: json-schema/circleci-workflow-job-list-schema.json
  - type: JSONSchema
    url: json-schema/circleci-rerun-workflow-response-schema.json
  - type: JSONSchema
    url: json-schema/circleci-message-response-schema.json
integrations:
- name: GitHub
- name: GitLab
- name: Bitbucket
- name: AWS
- name: GCP
- name: Azure
- name: Kubernetes
x-aliases:
- CircleCI
x-enrichment:
  date: '2026-10-04'
  status: enriched
  artifacts_added: 49
  pass: modular-v1
  engine: identity=local,contract=local,surfaces=local,docs=local,regulatory=local

CircleCI API — frequently asked questions

Does CircleCI have an API?

Yes. APIs.io lists 18 APIs from CircleCI, including CircleCI Self-Hosted Runner API, CircleCI Webhooks and CircleCI Orbs Registry, and 15 more.

Is there an OpenAPI specification for the CircleCI API?

Yes. APIs.io indexes 16 OpenAPI specifications for CircleCI, each linked for download from this page.

How do I authenticate with the CircleCI API?

CircleCI documents its authentication (apiKey/http · 3 schemes). The details are profiled on APIs.io as Circleci Authentication.

How much does the CircleCI API cost?

CircleCI publishes its prices; its Free plan is $0/month as of 2026-10-28. APIs.io lists 3 pricing plans for CircleCI, with each plan's price, limits and inclusions under Pricing on this page.

Does CircleCI have an MCP server?

Yes. APIs.io lists 1 MCP server for CircleCI: Remote MCP server at mcp.circleci.com over HTTP.

Is the CircleCI API ready for AI agents?

CircleCI has a Kin Score of 69.1 out of 100 (exemplar) and an Agent Readiness score of 56.1 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this

find_providersBrowse and filter every provider in the catalog.
get_provider_artifactsEvery artifact this provider publishes, grouped by type.
get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
get_provider_ratingPRO — composite, band, trend and facet scores.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This provider

curl "https://apis.io/api/v1/providers/circleci"

All providers

curl "https://apis.io/api/v1/providers?limit=25"

Every operation they expose

curl "https://apis.io/api/v1/providers/circleci/operations?limit=25"

How their score was established

curl "https://apis.io/api/v1/providers/circleci/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.