AbleFlowDocs

AbleFlow public API

Version 1.0.0 · 28 endpoints. Pick an endpoint on the left to see its request and response schemas, examples and Try it.

Download OpenAPI 3.1

Authentication

Send a Authorization: Bearer afk_… token and the AbleFlow-Version header with every request.

cURL
curl "$ABLEFLOW_API/api/…" \
  -H "Authorization: Bearer afk_…" \
  -H "AbleFlow-Version: 1.0.0"

Conventions

  • 선택 칸(optional: true, .d.ts 의 ?:)은 응답에서 키가 빠질 수 있다는 뜻이다(값이 있으면 null 이 아니다). null 값이 올 수 있으면 칸의 스키마에 null 이 들어 있다(.d.ts 의 | null). 둘은 따로 적는다: 키가 늘 있고 null 일 수 있으면 필수 + null, 키가 빠질 수 있으면 선택. 요청의 선택 칸은 빼도 null 로 보내도 같다(OpenAPI 는 그래서 선택 칸을 null 허용으로 싣는다)
  • 시각은 ISO-8601 문자열(UTC, 예: 2026-11-02T01:03:00Z)
  • PaginationResponse<T>: { count, prev, next, results }. 요청은 offset · limit · sort(property:ASC|DESC)
  • 쿼리의 배열은 콤마로 이어 보낸다(status=A,B)

Token scopes

ScopeDescription
projects:read프로젝트 읽기
projects:write프로젝트 쓰기(읽기 포함)
screens:read화면 읽기
screens:write화면 쓰기(읽기 포함)
diagnoses:read진단 회차(쓰기는 실행 · 다시 하기) 읽기
diagnoses:write진단 회차(쓰기는 실행 · 다시 하기) 쓰기(읽기 포함)
results:read진단 결과 · 비교 · 추세 · 리포트 · 우선순위 읽기
results:write진단 결과 · 비교 · 추세 · 리포트 · 우선순위 쓰기(읽기 포함)
issues:read개선 과제(쓰기는 상태 바꾸기) 읽기
issues:write개선 과제(쓰기는 상태 바꾸기) 쓰기(읽기 포함)
labels:read레이블 읽기
labels:write레이블 쓰기(읽기 포함)
schedules:read반복 진단 일정 읽기
schedules:write반복 진단 일정 쓰기(읽기 포함)
members:read구성원 목록 읽기. 없으면 사람 표시의 email 이 빠진다

Common errors

Common to every public API
StatusCodeWhen
400UNSUPPORTED_API_VERSIONAbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported }
401UNAUTHORIZEDAuthorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다
401INVALID_TOKEN토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함)
401TOKEN_EXPIRED토큰이 만료됐다
403INSUFFICIENT_SCOPE토큰 범위가 모자란다. detail { required }
403DEMO_READ_ONLY데모 토큰은 GET · HEAD 만 부를 수 있다
403PLAN_FEATURE_REQUIRED워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? }
404RESOURCE_NOT_FOUND자원이 없거나 토큰이 묶인 워크스페이스 밖이다
429API_RATE_LIMITED호출 한도를 넘었다. Retry-After(초)

Endpoints