PUT/v1/cards-by-external-id/{external_id}

외부 ID로 카드 생성 또는 교체

upsert_card_by_external_id

연동 개발자가 정한 external_id 값으로 카드를 생성하거나 교체해요. 텍스트는 application/json 형식(CardTextUpsert)으로, 파일은 multipart/form-data 형식(CardFileUpsertForm, POST /v1/cards와 같은 파일 검사)으로 보내세요. 조직에 이 external_id 값을 가진 카드가 없으면 본문에 지정한 컬렉션과 폴더에 카드를 생성해요(201). 카드가 있으면 내용을 새 버전으로 교체하고 파일의 새 버전과 같은 방식으로 다시 인덱싱하며, 카드 정보(제목, 태그, 담당자, 카테고리, metadata)는 보낸 값으로 바뀌어요(200). 내용이 바뀌지 않았으면 새 버전을 만들지 않으므로(status: skipped, reason: unchanged) Idempotency-Key 헤더 없이 요청을 반복해도 안전해요. metadata 값을 보내면 객체 전체를 교체해요. 접근 권한은 카드를 생성할 때는 업로드와 같은 방식으로, 교체할 때는 카드 수정과 같은 방식으로 확인해요. 호출자가 일부만 볼 수 있는 카드의 내용은 교체하지 않아요(403 cards.content_whole_access). 소스 카드는 이 방법으로 덮어쓰지 않아요. external_id 값이 사용자 지정 소스의 문서에 속하거나 찾은 카드를 소스가 관리하고 있으면 409 cards.managed_by_source 오류를 반환해요. 내용을 바꾸면 다른 새 버전과 마찬가지로 카드의 검증이 해제돼요(사유 update).

인증

Authorization 헤더로 API 키를 보내세요: Authorization: Bearer <키>.

경로 파라미터

external_idstring필수
카드의 external_id 값: 조직 안에서 고유한 1~512자의 문자열.
length ≥ 1, length ≤ 512

헤더 파라미터

X-View-Asstring
admin 역할의 API 키만 쓸 수 있어요. <profile>[:viewer|verifier|editor] 형식의 데이터 프로필로 요청을 보내요(예: employee:viewer). 설치 키는 이 헤더를 쓸 수 없어요(403).

쿠키 파라미터

kb_view_asstring
세션의 “View as” 모드(다른 사용자로 보기) 쿠키. POST /auth/view-as 요청으로 설정하고 DELETE /auth/view-as 요청으로 지워요.

요청 본문

application/json

객체: CardTextUpsert

titlestring
length ≥ 1, length ≤ 200
bodystring필수
content_type 형식의 카드 텍스트.
length ≥ 1, length ≤ 500000
content_typeCardTextContentType
collectionstring
카드를 생성할 때 이름으로 지정하는 컬렉션. 기본값은 설치 환경의 기본 컬렉션이에요.
collection_idinteger | null
카드를 생성할 때 ID로 지정하는 컬렉션. collection 값도 전달하면 collection_id 값이 우선해요.
folder_idstring | null
새 카드를 넣을 컬렉션의 폴더로, 파일 업로드의 folder_id 필드와 같은 검사를 거쳐요.
length ≤ 64
tagsarray of string | null
items ≤ 30
categorystring | null
length ≤ 60
sensitiveboolean | null
owner_idinteger | null
verify_interval_daysinteger | null
≥ 1, ≤ 3650
metadataMetadataPatch
asyncboolean
true이면 즉시 반환하고 대기열에서 카드를 인덱싱해요. false이면 인덱싱이 끝난 뒤 반환해요.
기본값: false

multipart/form-data

객체: CardFileUpsertForm

filestring (application/octet-stream)필수
titlestring | null
카드 제목. 전달하지 않으면 새 카드는 파일 이름을 제목으로 받고, 기존 카드는 제목을 유지해요.
length ≤ 200
collectionstring
collection_idinteger | null
folder_idstring | null
length ≤ 64
tagsstring
쉼표로 구분한 태그.
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
metadatastring | null
metadata 값: 폼 필드의 값으로 넣는 JSON 객체. 규칙은 MetadataPatch 객체와 같아요.
asyncboolean
기본값: false

응답

200카드가 이미 있었어요. 내용이 교체되었거나(`queued`, `ready`, `error`) 바뀌지 않았어요(`skipped`).

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: UploadResult

statusstring필수
허용 값: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged 또는 an identical file is already indexed.
tablesinteger
timingsobject
필드
- total_snumber
errorstring

201카드가 생성되었어요(비동기 요청이면 `queued`, 동기 요청이면 `ready` 또는 `error`).

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: UploadResult

statusstring필수
허용 값: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged 또는 an identical file is already indexed.
tablesinteger
timingsobject
필드
- total_snumber
errorstring

400잘못된 요청이에요. 파라미터 값이나 객체의 상태 때문에 이 동작을 할 수 없어요(`detail` 필드에 메시지가 있어요).

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

401자격 증명(세션 쿠키나 API 키)을 보내지 않았거나 키를 찾을 수 없어요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

402조직이 요금제 한도(카드, 저장 공간, 사용자)에 도달했어요. `error.details` 필드에 `kind`, `limit`, `used` 값이 들어 있어요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

403이 동작은 허용되지 않아요. 역할이 부족하거나, 컬렉션이나 카드에 접근할 수 없거나, 요청이 “View as” 모드로 실행 중이거나, 조직이 정지 또는 삭제된 경우예요(`detail` 필드는 `code: org_suspended | org_deleted` 값을 가진 객체예요).

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

404객체가 없거나 접근할 수 없어요. API는 접근이 제한된 객체가 존재하는지 확인해 주지 않아요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

409객체의 상태 때문에 이 동작을 할 수 없어요. 예를 들어 중복이거나, 인덱싱 중이거나, 이미 처리된 작업인 경우예요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

413요청 본문이 허용 크기를 넘었어요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

415지원하지 않는 파일 형식이에요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

422유효성 검사 오류예요. 본문이나 파라미터가 스키마와 맞지 않거나(`detail` 필드는 유효성 검사 오류 목록), 파라미터 값이 허용 범위를 벗어났어요(`detail` 필드는 메시지).

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

429요청이 너무 많거나(`api.rate_limited`), 조직의 분·일·월 할당량을 다 썼거나(`api.quota_exceeded`, `error.details` 필드에 `quota`, `limit`, `reset_at` 값이 있어요), 조직의 한도에 도달했거나, 답변 서비스가 바쁜 상태예요(`answers.engine_busy`). `Retry-After` 헤더에 적힌 시간만큼 기다리세요.

응답 헤더

Retry-After
요청을 다시 시도하기 전에 기다릴 초.
RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

503이 요청에 필요한 서비스를 일시적으로 사용할 수 없어요. 잠시 후 다시 시도하세요.

응답 헤더

RateLimit-Policy
적용 중인 한도. IETF 초안 draft-ietf-httpapi-ratelimit-headers 형식이며, 쉼표로 구분한 "<name>";q=<quota>;w=<window in seconds> 항목으로 이루어져요. key 항목은 API 키의 요청 속도예요(할당량은 버스트, 시간 창은 버스트가 완전히 다시 채워지는 시간이에요. 세션에서는 user, 자격 증명이 없으면 ip예요). minute, day, month 항목은 UTC 기준 달력상의 분, 일, 월에 대한 조직의 할당량이에요.
RateLimit
RateLimit-Policy 헤더의 각 한도에서 남은 양: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
RateLimit-Policy 헤더에서 가장 엄격한 항목(남은 요청 수가 가장 적은 항목)의 한도.
X-RateLimit-Remaining
가장 엄격한 한도에서 남은 요청 수.
X-RateLimit-Reset
가장 엄격한 한도가 초기화될 때까지 남은 초.

application/json

객체: Error

오류 코드

모든 요청에 공통으로 쓰이는 코드 외에 이 엔드포인트가 error.code로 반환할 수 있는 코드예요.

호출 한도

응답에는 RateLimit, RateLimit-Policy 헤더와 이전 헤더인 X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset이 담겨요. 429 응답에는 초 단위의 Retry-After 헤더가 있어요. 그만큼 기다린 뒤 재시도하세요.

← cards · API 레퍼런스

curl -X PUT 'https://api.sursa.com/v1/cards-by-external-id/EXTERNAL_ID' \
  -H "Content-Type: application/json" \
  -d '{"title":"Refund policy","body":"# Refund policy\n\nRefunds are processed within 14 days.","collection":"support"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

사용해 보기

API 키

키는 이 탭의 메모리에만 보관되며 https://api.sursa.com 주소로만 전송돼요.

요청은 조직의 실제 데이터에 적용돼요.

X-View-As header

external_id path *

요청 본문(JSON)