Workflow API

단일 모델의 계약이 아니라 안정적인 BeatAPI 기능이 필요할 때 Workflow API를 사용하세요.

두 워크플로 모두 비동기 방식입니다:

1. 작업을 만들고 data.id를 저장하세요.
2. 5~10초마다 GET /v1/tasks/{task_id}를 폴링하세요.
3. succeeded 또는 failed에서 멈추세요. Music Video 수동 검토는 requires_action에서 일시 정지될 수 있습니다.
4. 폴링이 동작한 뒤 알림용으로 서명된 웹훅을 사용하세요.

필드 단위 전체 계약은 Music Video, Ecommerce Video, Video Analysis를 참고하세요.

워크플로 종류 목록

GET /v1/workflows

이 공개 엔드포인트는 파라미터가 없으며 인증이 필요하지 않습니다.

curl https://api.beatapi.io/v1/workflows

{
  "data": {
    "object": "list",
    "data": [
      {
        "id": "music-video",
        "object": "workflow",
        "name": "Music Video API",
        "description": "Generate short music video clips from audio, lyrics, and visual direction."
      },
      {
        "id": "ecommerce-video",
        "object": "workflow",
        "name": "Ecommerce Video API",
        "description": "Generate product ad videos from product images and a short creative brief."
      },
      {
        "id": "video-analysis",
        "object": "workflow",
        "name": "Video Analysis API",
        "description": "Analyze an uploaded video with timestamp-aware multimodal reasoning."
      }
    ]
  }
}

429 rate_limit_exceeded에는 Retry-After와 error.retry_after_seconds가 포함될 수 있습니다. 재시도 전에 최소 그만큼 기다리세요.

공통 운영 규칙

• Base URL: https://api.beatapi.io.
• 영구 API 키는 신뢰할 수 있는 서버에 보관하세요.
• 입력은 공개되어 접근 가능해야 합니다. 로컬 자산에는 POST /v1/files를 사용하세요.
• 생성 요청은 크레딧을 보류하고 정규화된 작업 객체를 반환합니다.
• request_id, 사용량, 상태, 오류, 최종 출력 URL을 기록하세요.
• 문서화된 멱등성 헤더가 없는 불확실한 생성 요청은 무작정 재시도하지 마세요.

생성 작업 하나만 필요하고 모델을 직접 고르고 싶다면 모델 단위의 Video API 또는 Image API를 선택하세요.