주요 콘텐츠로 건너뛰기
문서API 오픈 플랫폼공식 SDK
개방형 플랫폼 · 12개 언어

Braidrun SDK

12개 언어를 지원하는 13개의 타입 안전 클라이언트로 워크플로, 실행, 결과물, 승인 및 Webhook API를 호출합니다.

Braidrun SDK는 개방형 플랫폼 API의 공식 타입 안전 클라이언트 모음입니다. 워크플로, 실행, 결과물, 수동 승인 및 Webhook 엔드포인트를 각 언어에 익숙한 메서드와 데이터 모델로 감싸므로 HTTP 요청과 응답 타입을 직접 작성할 필요가 없습니다.

공식 소스 저장소github.com/Braidrun/braidrun-sdk모든 클라이언트는 동일한 OpenAPI 3.0.3 명세에서 생성되어 일관된 API 1.0 인터페이스와 모델을 제공합니다.
저장소 보기

지원 클라이언트

저장소에는 12개 언어를 지원하는 13개의 클라이언트 구현이 있습니다. 각 디렉터리는 패키지 메타데이터, API 모델, 테스트와 해당 언어의 전체 엔드포인트 문서를 포함하는 독립 클라이언트입니다.

API 지원 범위

각 언어 클라이언트는 동일한 공개 기능을 지원하며 메서드 이름은 언어 관례에 맞게 자동 변환됩니다.

기능 영역수행할 수 있는 작업
워크플로워크플로를 나열하고 조회하며 실행을 비동기로 시작합니다.
실행하다상태, 기록 및 최종 결과를 조회하거나 실행 중인 작업을 취소합니다.
산출물실행에서 생성된 파일과 결과물 메타데이터를 조회합니다.
수동 승인승인 대기 항목을 조회하고 승인 또는 거부 결정을 제출합니다.
WebhookWebhook을 등록 및 관리하고 통계를 확인하며 Webhook으로 워크플로를 트리거합니다.

빠른 시작

  1. ‘계정 설정 → API 키’에서 키를 만들고 호출에 필요한 권한 범위만 부여합니다.
  2. 기술 스택에 맞는 클라이언트를 선택하고 해당 디렉터리의 README를 엽니다.
  3. 소스에서 종속성을 설치하고 환경 변수로 API Key를 구성합니다.
  4. API 클라이언트를 만든 다음 먼저 워크플로 목록을 호출해 연결과 권한을 확인합니다.
terminalbash
python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"
list_workflows.pypython
import os
import braidrun_sdk

configuration = braidrun_sdk.Configuration(
    host="https://braidrun.com",
    access_token=os.environ["BRAIDRUN_API_KEY"],
)

with braidrun_sdk.ApiClient(configuration) as client:
    workflows = braidrun_sdk.WorkflowsApi(client)
    result = workflows.list_workflows()
    print(result)
현재 소스 형태로 배포

SDK는 현재 GitHub 소스 저장소를 통해 제공되며 언어별 패키지 관리자의 배포 상태는 서로 다를 수 있습니다. 해당 디렉터리의 README를 기준으로 하고 모든 클라이언트가 공개 패키지 저장소에 배포되었다고 가정하지 마세요.

인증 및 권한

dyk_로 시작하는 API Key는 환경 변수나 비밀 관리 서비스에서 읽고 Bearer Header를 사용하는 것이 좋습니다. 실제 키를 소스 코드, 로그 또는 브라우저 프런트엔드에 기록하지 마세요. 각 엔드포인트는 여전히 해당 권한 범위를 확인하며, 클라이언트의 타입 안전성이 권한을 자동으로 부여하지는 않습니다.

Webhook 관리 API는 다른 인증 방식을 사용합니다

SDK는 Webhook 관리 API도 생성하지만 /api/webhooks 아래의 관리 엔드포인트는 브라우저 세션 또는 관리자 서비스 계정을 사용하며 일반적인 세분화된 개방형 플랫폼 API Key를 허용하지 않습니다. Webhook 트리거 엔드포인트에는 WEBHOOK_TRIGGER 권한 범위가 있는 개방형 플랫폼 키를 계속 사용할 수 있습니다.

API가 429를 반환하면 Retry-After를 따르고 X-RateLimit-Limit와 X-RateLimit-Window를 활용해 재시도 간격을 조정하세요.

SDK와 워크플로 엔진 선택 가이드

프로젝트장면에 적합실행 위치
braidrun-sdk언어별 타입과 모델을 사용해 애플리케이션에서 Braidrun 클라우드 플랫폼 API를 호출합니다.애플리케이션 + Braidrun 클라우드 플랫폼
braidrun-workflow자체 환경에서 YAML 워크플로를 실행하거나 Kotlin/JVM 프로젝트에 런타임을 포함합니다.직접 관리하는 로컬, 서버 또는 CI 환경

두 프로젝트 전체 소개 보기

관련 페이지