API 레퍼런스

이 페이지는 Sume 문서 셸 안의 가벼운 라우트 레퍼런스입니다. 정확한 요청과 응답 스키마는 OpenAPI JSON을 사용하세요.

OpenAPI 스키마

현재 미리보기의 스키마 스냅샷은 다음에서 확인할 수 있습니다.

/api/openapi.json

프로덕션 Sume은 live schema를 다음 경로에서 제공합니다.

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

스키마 다운로드:

curl https://www.sume.so/api/v1/openapi.json \
  -o sume-openapi.json

모든 Public API v1 엔드포인트는 워크스페이스 범위 API 키를 사용합니다.

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

요청 본문에 workspace_id나 user_id를 전달하지 마세요. Sume은 API 키에서 범위를 결정합니다.

엔드포인트	목적
`GET /me`	인증된 사용자, API 키 메타데이터, 워크스페이스 컨텍스트를 읽습니다.
`GET /credits`	크레딧, 플랜, 활성 생성 용량을 읽습니다.
`GET /brand`	정리된 Brand DNA 프로필을 나열합니다.
`GET /brand/current`	현재 워크스페이스 Brand DNA 프로필을 읽습니다.
`GET /avatars`	사용할 수 있는 공개/워크스페이스 아바타를 나열합니다.
`GET /jobs`	워크스페이스 범위 작업을 나열합니다.
`GET /jobs/{jobId}`	한 작업의 상태를 읽습니다.
`GET /jobs/{jobId}/result`	한 작업의 결과를 읽습니다.
`GET /assets`	색인된 Asset Library 장면 에셋을 나열하거나 검색합니다.
`GET /assets/{assetId}`	한 장면 에셋을 읽습니다.

생성 엔드포인트는 크레딧을 사용할 수 있습니다. 에이전트는 사용자가 명확히 생성 작업을 승인하지 않았다면 호출 전에 확인해야 합니다.

엔드포인트	목적
`POST /images/generations`	비동기 이미지 생성 작업을 만듭니다.
`POST /videos/generations`	비동기 비디오 생성 작업을 만듭니다.
`POST /ads/videos`	AI Ads 비디오 작업을 만듭니다.
`POST /face-swap`	하나 이상의 Face Swap 작업을 만듭니다.
`POST /reference-analysis`	공개 TikTok 또는 Instagram Reel URL 분석 작업을 만듭니다.
`POST /uploads/presign`	미디어 업로드용 임시 URL을 만듭니다.
`POST /assets`	업로드된 에셋을 finalize하고 Asset Library ingest를 enqueue합니다.

크레딧 확인:

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

Asset Library 장면 검색:

curl "https://www.sume.so/api/v1/assets?q=product%20demo&limit=5" \
  -H "Authorization: Bearer $SUME_API_KEY"