Skip to main content

Easily Integrate
CircleCI's API using Konfig's TypeScript SDK

Need a TypeScript SDK for CircleCI's API?

Growing API Companies trust Konfig's SDKs to onboard developers to their API.

SnapTradeHumanloopSplititLeapGroundx

First, instantiate the SDK

It only takes a few lines of code.

index.ts

import { CircleCi } from 'circle-ci-typescript-sdk';
const circleCi = new CircleCi({
// Project API tokens are not supported for API v2. Use a personal API token.
apiKeyHeader: "CIRCLE_TOKEN",
// HTTP basic authentication. The username should be set as the circle-token value, and the password should be left blank. Note that project tokens are currently not supported on API v2.
username: "USERNAME",
password: "PASSWORD",
// DEPRECATED - we will remove this option in the future. Project API tokens are not supported for API v2. Use a personal API token.
apiKeyQuery: "CIRCLE_TOKEN"
})

Then, send your first request

We made it really easy.

index.ts

// List contexts
const listOwnerContextsResponse = circleCi.context.listOwnerContexts()

Enjoy a buttery smooth developer experience with 78 SDK methods

How Konfig Works

Konfig collects APIs and automatically generates SDKs so you can focus on building your application.

openapi-examples

Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository

We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.

openapi-examples-to-konfig

Generates AI-Augmented SDKs from openapi-examples

Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.

konfig-to-package-managers

Publishes to standard package managers

We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.

CircleCI

About CircleCI

CircleCI is the software delivery engine for teams who want to ship software faster and with confidence. We do this today by building the world's best platform for Continuous Integration and Continuous Delivery (CI/CD). Ultimately, we plan to map every source of change for software teams, so they can accelerate innovation and growth. Our platform was built by a team of DevOps experts who understand how critical CI/CD is to your entire development process and your entire business. The best software teams know that speed, focus, and consistency of delivery make the difference between good and great. We built CircleCI to deliver on these promises so you can deliver on yours — to reliably bring only the highest quality products to your customers. CircleCI is proud to be an Equal Opportunity and Affirmative Action employer. We do not discriminate based upon race, religion, color, national origin, sexual orientation, gender, gender identity, gender expression, transgender status, sexual stereotypes, age, status as a protected veteran, status as an individual with a disability, or other applicable legally protected characteristics. We also consider qualified applicants with criminal histories, consistent with applicable federal, state and local law.

Keywords

developer_tools
automation
collaboration
continuous_integration
continuous_delivery
continuous_integration
continuous_delivery
continuous_deployment
containers
devops
cicd
ci
cd
software_delivery
ci_platform
software_testing
developer_experience

Start integrating CircleCI's API with Konfig