REST API

라벨

워크스페이스 라벨, 여러 레코드의 라벨 상태와 추천 라벨을 조회합니다.

GET/v2/workspaces/{slug}/labels

라벨 목록 조회

워크스페이스의 라벨과 라벨별 레코드 수를 조회합니다.

파라미터

slug필수stringpath
워크스페이스 슬러그입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/labels" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

items필수V2LabelWithRecordCount[]
이 값에 포함된 항목 목록입니다.
id필수integer
라벨 식별자입니다.
name필수string
라벨 이름입니다.
color필수string
라벨 표시 색상입니다.
record_count필수integer
레코드 수입니다.

응답 예시

{
  "items": [
    {
      "id": 1,
      "name": "Example",
      "color": "string",
      "record_count": 1
    }
  ]
}

오류

상태	오류 코드	설명
401	UNAUTHORIZED	인증되지 않은 요청
403	FORBIDDEN	요청자 권한 부족
404	WORKSPACE_NOT_FOUND	존재하지 않음
422	VALIDATION_ERROR	처리할 수 없는 콘텐츠
429	RATE_LIMIT_EXCEEDED	요청 한도 초과자세히

GET/v2/workspaces/{slug}/records/labels/status

여러 레코드의 라벨 상태 조회

지정한 여러 레코드의 라벨 적용 상태를 조회합니다.

파라미터

slug필수stringpath
워크스페이스 슬러그입니다.
record_ids필수integer[]query
라벨 상태를 조회할 레코드 식별자 목록입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels/status?record_ids=1" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

labels필수V2BulkLabelStatusItem[]
리소스와 연결된 라벨 목록입니다.
id필수integer
라벨 식별자입니다.
name필수string
라벨 이름입니다.
color필수string
라벨 표시 색상입니다.
status필수·
V2BulkLabelStatus
현재 상태입니다.

응답 예시

{
  "labels": [
    {
      "id": 1,
      "name": "Example",
      "color": "string",
      "status": "unchecked"
    }
  ]
}

오류

상태	오류 코드	설명
401	UNAUTHORIZED	인증되지 않은 요청
403	FORBIDDEN	요청자 권한 부족
404	WORKSPACE_NOT_FOUND	존재하지 않음
422	VALIDATION_ERROR	처리할 수 없는 콘텐츠
429	RATE_LIMIT_EXCEEDED	요청 한도 초과자세히

POST/v2/workspaces/{slug}/records/labels

여러 레코드에 라벨 연결

지정한 여러 레코드에 라벨을 연결합니다.

파라미터

slug필수stringpath
워크스페이스 슬러그입니다.

요청 본문

라벨을 연결할 레코드와 라벨 목록입니다.

record_ids필수integer[]
라벨 연결을 변경할 레코드 식별자 목록입니다.
label_ids필수integer[]
연결하거나 연결 해제할 라벨 식별자 목록입니다.

요청 예시

curl --request POST \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT" \
  --header "Content-Type: application/json" \
  --data '{
  "record_ids": [
    1
  ],
  "label_ids": [
    1
  ]
}'

성공 응답

오류

상태	오류 코드	설명
400	INVALID_LABEL_SELECTION	유효하지 않은 요청
401	UNAUTHORIZED	인증되지 않은 요청
403	FORBIDDEN	요청자 권한 부족
404	WORKSPACE_NOT_FOUND	존재하지 않음
422	VALIDATION_ERROR	처리할 수 없는 콘텐츠
429	RATE_LIMIT_EXCEEDED	요청 한도 초과자세히

DELETE/v2/workspaces/{slug}/records/labels

여러 레코드의 라벨 연결 해제

지정한 여러 레코드에서 라벨 연결을 해제합니다.

파라미터

slug필수stringpath
워크스페이스 슬러그입니다.

요청 본문

라벨 연결을 해제할 레코드와 라벨 목록입니다.

record_ids필수integer[]
라벨 연결을 변경할 레코드 식별자 목록입니다.
label_ids필수integer[]
연결하거나 연결 해제할 라벨 식별자 목록입니다.

요청 예시

curl --request DELETE \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/labels" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT" \
  --header "Content-Type: application/json" \
  --data '{
  "record_ids": [
    1
  ],
  "label_ids": [
    1
  ]
}'

성공 응답

오류

상태	오류 코드	설명
400	INVALID_LABEL_SELECTION	유효하지 않은 요청
401	UNAUTHORIZED	인증되지 않은 요청
403	FORBIDDEN	요청자 권한 부족
404	WORKSPACE_NOT_FOUND	존재하지 않음
422	VALIDATION_ERROR	처리할 수 없는 콘텐츠
429	RATE_LIMIT_EXCEEDED	요청 한도 초과자세히

GET/v2/workspaces/{slug}/records/{record_id}/label-recommendations

레코드 라벨 추천 조회

레코드에 대해 생성된 라벨 추천 목록을 조회합니다.

파라미터

record_id필수integerpath
레코드 식별자입니다.
slug필수stringpath
워크스페이스 슬러그입니다.

요청 예시

curl --request GET \
  --url "https://api.callabo.ai/v2/workspaces/your-workspace/records/1/label-recommendations" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $CALLABO_PAT"

성공 응답

응답 본문

record_id필수integer
레코드 식별자입니다.
recommendations필수V2RecommendedLabel[]
레코드 라벨 추천 목록입니다.
label_id필수integer
추천 라벨 식별자입니다.
label_name필수string
추천 라벨 이름입니다.

응답 예시

{
  "record_id": 1,
  "recommendations": [
    {
      "label_id": 1,
      "label_name": "string"
    }
  ]
}

오류

상태	오류 코드	설명
401	UNAUTHORIZED	인증되지 않은 요청
403	FORBIDDEN	요청자 권한 부족
404	RECORD_NOT_FOUND	존재하지 않음
422	VALIDATION_ERROR	처리할 수 없는 콘텐츠
429	RATE_LIMIT_EXCEEDED	요청 한도 초과자세히