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.
Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.
API Evangelist profiles CircleCI the way a machine reads it — 100 machine-readable artifacts across 18 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — CircleCI scores 64.4/100 (strong), with a separate agent-readiness read of 54/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
How we profile CircleCI
Each block below is one kind of artifact we hold for CircleCI. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 18
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
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 within the panel for all 18 ·
Open Collections 3
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
CircleCI REST API v1
OPEN COLLECTIONCircleCI REST API v2
OPEN COLLECTIONCircleCI Self-Hosted Runner API
OPEN COLLECTIONPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Circleci Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Circleci Finops
FINOPSFeatures 16
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
Notable capabilities this provider offers.
Scroll within the panel for all 16 ·
Event Specifications 1
Not every API is request/response. AsyncAPI describes the event-driven and streaming side — the webhooks and channels — so the asynchronous half of the interface is documented the same way the synchronous half is.
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...
ASYNCAPISemantic Vocabularies 1
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Circleci Context
JSON-LDSpectral Rules 3
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
JSON Schema 49
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
Artifact
JSON SCHEMAArtifactList
JSON SCHEMABuild
JSON SCHEMABuildDetail
JSON SCHEMABuildSummary
JSON SCHEMACheckoutKey
JSON SCHEMACheckoutKeyList
JSON SCHEMACollaboration
JSON SCHEMAContext
JSON SCHEMAContextList
JSON SCHEMACreateContextRequest
JSON SCHEMACreateScheduleRequest
JSON SCHEMACreateWebhookRequest
JSON SCHEMAEnvironmentVariable
JSON SCHEMAEnvironmentVariableList
JSON SCHEMAErrorResponse
JSON SCHEMAInsightsJobMetrics
JSON SCHEMAInsightsTestMetrics
JSON SCHEMAInsightsWorkflowMetrics
JSON SCHEMAInsightsWorkflowRuns
JSON SCHEMAJob
JSON SCHEMAMessageResponse
JSON SCHEMACircleCI Pipeline
JSON SCHEMAPipelineConfig
JSON SCHEMAPipelineCreation
JSON SCHEMAPipelineList
JSON SCHEMAProject
JSON SCHEMAProjectEnvVar
JSON SCHEMAProjectEnvVarList
JSON SCHEMARerunWorkflowResponse
JSON SCHEMAResourceClass
JSON SCHEMAResourceClassCreation
JSON SCHEMARunner
JSON SCHEMASchedule
JSON SCHEMAScheduleList
JSON SCHEMATestList
JSON SCHEMATestMetadata
JSON SCHEMATimetable
JSON SCHEMATriggerPipelineRequest
JSON SCHEMAUpdateScheduleRequest
JSON SCHEMAUpdateWebhookRequest
JSON SCHEMAUser
JSON SCHEMACircleCI Webhook Event
JSON SCHEMAWebhookInfo
JSON SCHEMAWebhookList
JSON SCHEMACircleCI Workflow
JSON SCHEMAWorkflowJob
JSON SCHEMAWorkflowJobList
JSON SCHEMAWorkflowList
JSON SCHEMAScroll within the panel for all 49 ·
JSON Structure 1
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Circleci Structure
JSON STRUCTURESecurity Posture 4
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for CircleCI — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 2
Portal, sign-up, and the first successful call
Documentation 4
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 2
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 4
Authentication, authorization, and security posture
Operate 2
Status, limits, changes, and where to get help
Commercial 2
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/circleci · machine-readable index on apis.io