CircleCI API

circleci.com

Community

This describes the resources that make up the CircleCI API v2.

Auth

api_key

Pricing

free

Spec version

1.0

Base URL

https://circleci.com/api/v2

Crawl failures

1

Last verified

2026-03-01T11:55:25.000Z

Health

This is a community-maintained manifest. Health monitoring is not available because this service doesn't host its own /.well-known/agent endpoint yet. Learn more about trust levels →

Capabilities

context

Manage context — create a new context, create context restriction, add or update an environment variable. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/context

insights

Manage insights — get summary metrics and trends for a project across it's workflows and branches, get summary metrics with trends for the entire org, and for each project, get all branches for a project. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/insights

job

Manage job — cancel job by job id, cancel job by job number, get job details. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/job

oidc_token_management

Manage oidc token management — get org-level claims, get project-level claims, patch org-level claims. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/oidc_token_management

organization

Manage organization — create a new organization, create a new url orb allow-list entry, get an organization. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/organization

pipeline

Manage pipeline — continue a pipeline, trigger a new pipeline, [recommended] trigger a new pipeline. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/pipeline

policy_management

Manage policy management — makes a decision, creates policy bundle for the context, retrieves the owner's decision audit logs. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/policy_management

project

Manage project — create a new project, create a new checkout key, create an environment variable. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/project

schedule

Manage schedule — create a schedule, list schedule triggers, get a schedule by id. available only on schedules associated with github oauth or bitbucket cloud pipeline definitions. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/schedule

user

Manage user — user information, collaborations, user information. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/user

webhook

Manage webhook — create an outbound webhook, update an outbound webhook, list webhooks. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/webhook

workflow

Manage workflow — cancel a workflow, rerun a workflow, approve a job. Supports standard CRUD operations through the REST API.

Detail: https://circleci.com/api/v2/capabilities/workflow

Agent Preview

This is what an AI agent sees when it discovers this service via the Gateway:

Service: CircleCI API
Description: This describes the resources that make up the CircleCI API v2.
Auth: api_key
Capabilities:
  - context: Manage context — create a new context, create context restriction, add or update an environment variable. Supports standard CRUD operations through the REST API.
  - insights: Manage insights — get summary metrics and trends for a project across it's workflows and branches, get summary metrics with trends for the entire org, and for each project, get all branches for a project. Supports standard CRUD operations through the REST API.
  - job: Manage job — cancel job by job id, cancel job by job number, get job details. Supports standard CRUD operations through the REST API.
  - oidc_token_management: Manage oidc token management — get org-level claims, get project-level claims, patch org-level claims. Supports standard CRUD operations through the REST API.
  - organization: Manage organization — create a new organization, create a new url orb allow-list entry, get an organization. Supports standard CRUD operations through the REST API.
  - pipeline: Manage pipeline — continue a pipeline, trigger a new pipeline, [recommended] trigger a new pipeline. Supports standard CRUD operations through the REST API.
  - policy_management: Manage policy management — makes a decision, creates policy bundle for the context, retrieves the owner's decision audit logs. Supports standard CRUD operations through the REST API.
  - project: Manage project — create a new project, create a new checkout key, create an environment variable. Supports standard CRUD operations through the REST API.
  - schedule: Manage schedule — create a schedule, list schedule triggers, get a schedule by id. available only on schedules associated with github oauth or bitbucket cloud pipeline definitions. Supports standard CRUD operations through the REST API.
  - user: Manage user — user information, collaborations, user information. Supports standard CRUD operations through the REST API.
  - webhook: Manage webhook — create an outbound webhook, update an outbound webhook, list webhooks. Supports standard CRUD operations through the REST API.
  - workflow: Manage workflow — cancel a workflow, rerun a workflow, approve a job. Supports standard CRUD operations through the REST API.