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 17 APIs on the APIs.io network, including Self-Hosted Runner API, Webhooks, Artifact API, and 14 more. Tagged areas include CI/CD, Continuous Integration, Continuous Deployment, DevOps, and Pipelines.

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

CircleCI’s developer surface includes authentication, developer portal, documentation, support, engineering blog, and 18 more developer resources.

🌐 Visit website 📡 Source on GitHub

61.6/100 strong ▬ flat Agent 43/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6

AccessFreemiumSelf serve⚡ Free to try

18 APIs 16 Features

CI/CDContinuous IntegrationContinuous DeploymentDevOpsPipelinesWorkflows

Kin Score

Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6

Composite quality — 61.6/100 · strong

Contract Quality 18.3 / 25

Developer Ergonomics 7.8 / 20

Commercial Clarity 16.3 / 20

Operational Transparency 6.8 / 13

Governance 5.0 / 12

Discoverability 7.4 / 10

Agent readiness — 43/100 · agent ready

Machine-Readable Contract 18 / 18

Agentic Access Contract 10 / 10

MCP Server 0 / 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 0 / 5

Well-Known Catalog 0 / 4

Consent & Bot Identity 0 / 3

A2A Agent Card 0 / 8

Dry-Run / Simulate Mode 0 / 4

Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/circleci: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 18

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

Rate Limits 1

Documented rate limits and quota policies.

Circleci Rate Limits

4 limits

RATE LIMITS

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

JSON Schema 49

Standalone JSON Schema definitions for this provider's data models.

Scroll for all 49

Get Started 2

Portal, sign-up, and the first successful call

Portal

Portal

Login

Documentation 4

Reference material describing how the API behaves

Documentation

JSONSchema

JSONSchema

JSONSchema

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess

AgenticAccess

LlmsText

LlmsText

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

JSONLD

JSONLD

Spectral

Spectral

Build 2

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace

PostmanWorkspace

GitHubOrganization

GitHubOrganization

Access & Security 4

Authentication, authorization, and security posture

TrustCenter

TrustCenter

VulnerabilityDisclosure

VulnerabilityDisclosure

DomainSecurity

DomainSecurity

Authentication

Authentication

Operate 2

Status, limits, changes, and where to get help

StatusPage

StatusPage

Support

Support

Commercial 2

Pricing, plans, and the legal terms of use

PrivacyPolicy

PrivacyPolicy

TermsOfService

TermsOfService

Company 3

The organization behind the API

LinkedIn

Website

Website

Blog

Blog

Source (apis.yml)

aid: circleci
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  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-05-19'
type: Index
access: 3rd-Party
position: Consumer
specificationVersion: '0.19'
tags:
- CI/CD
- Continuous Integration
- Continuous Deployment
- DevOps
- Pipelines
- Workflows
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.
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
  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
  - 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/
- 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:
  - 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/
- 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/
- 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/
- 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/
- 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:
  - 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/
- 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/
- 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/
- 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/
- 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/
- 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/
- 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/
- 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/
- 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:
  - 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/
common:
- 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
integrations:
- name: GitHub
- name: GitLab
- name: Bitbucket
- name: AWS
- name: GCP
- name: Azure
- name: Kubernetes
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com

CircleCI

APIs 18

Postman Collections 16

Open Collections 3

Pricing Plans 1

Rate Limits 1

FinOps 1

Features 16

Event Specifications 1

Semantic Vocabularies 1

Spectral Rules 3

JSON Schema 49

JSON Structure 1

Security Posture 4

Agentic Access 1

Get Started 2

Documentation 4

Agent Surfaces 2

Design & Contract 2

Build 2

Access & Security 4

Operate 2

Commercial 2

Company 3

Source (apis.yml)