|문서

빠른 시작

Sume은 워크스페이스 범위의 Public API와 에이전트 친화적인 CLI를 제공합니다. 두 도구는 같은 흐름을 따릅니다. 인증하고, API 키가 연결된 워크스페이스에서 생성 또는 검색을 실행한 뒤, 안정적인 작업과 에셋 엔드포인트로 결과를 읽습니다.

Base URL

https://www.sume.so/api/v1

다른 Sume 환경을 의도적으로 테스트하는 경우가 아니라면 이 프로덕션 주소를 사용하세요.

1. 인증

Sume에서 API 키를 만들고 서버 측에 안전하게 보관합니다.

export SUME_API_KEY="sume_live_..."

키에 연결된 계정과 워크스페이스를 확인합니다.

curl https://www.sume.so/api/v1/me \
  -H "Authorization: Bearer $SUME_API_KEY"

API 키가 워크스페이스 범위를 결정합니다. 요청 본문에 workspace_id나 user_id를 직접 보내지 마세요.

2. 크레딧 확인

생성 엔드포인트는 크레딧을 사용할 수 있습니다. 작업을 만들기 전에 잔액과 동시 실행 상태를 확인하세요.

curl https://www.sume.so/api/v1/credits \
  -H "Authorization: Bearer $SUME_API_KEY"

CLI에서는 다음과 같이 확인합니다.

sume credits

3. 이미지 작업 만들기

curl https://www.sume.so/api/v1/images/generations \
  -H "Authorization: Bearer $SUME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Clean skincare product photo on a white bathroom counter.",
    "aspect_ratio": "1:1",
    "image_count": 1
  }'

응답은 비동기 작업을 수락했다는 의미이며 작업 id를 포함합니다.

{
  "object": "image_generation",
  "job": {
    "id": "job_...",
    "status": "queued"
  }
}

CLI 예시는 다음과 같습니다.

sume images generate \
  --prompt "Clean skincare product photo on a white bathroom counter." \
  --aspect-ratio 1:1 \
  --wait \
  --json

4. 상태 폴링

curl https://www.sume.so/api/v1/jobs/job_123 \
  -H "Authorization: Bearer $SUME_API_KEY"

일반적인 종료 상태는 completed, failed, canceled, expired입니다. 작업이 아직 queued, running, processing이면 잠시 기다린 뒤 다시 조회합니다.

5. 결과 가져오기

curl https://www.sume.so/api/v1/jobs/job_123/result \
  -H "Authorization: Bearer $SUME_API_KEY"

결과에는 안전한 공개 미디어 URL과 메타데이터가 포함될 수 있습니다. 쿼리 문자열이나 비공개 토큰이 들어간 전체 URL은 로그에 남기지 마세요.

6. Asset Library 검색

Asset Library는 장면 단위로 색인된 레코드를 반환합니다. 재사용 가능한 클립, 생성 결과, 훅, CTA, 제품 데모, 소스 영상 메타데이터를 찾는 데 사용합니다.

sume assets search "product demo hook" \
  --source-type generated \
  --limit 5 \
  --json

다음 단계