탐색으로 건너뛰기

이펙트 API

버전이 지정된 BeatAPI 이펙트로 비동기 이미지 또는 영상 이펙트 작업을 생성합니다.

작업을 만들기 전에 이펙트 카탈로그를 읽어 이미지 수, 출력 종류, 지원 옵션, 버전을 확인하세요. 입력이 로컬 파일이면 로컬 입력을 업로드하세요. data.id를 저장하고, 작업을 폴링하며, 오류 및 재시도 정책을 따르세요.

인증

AuthorizationBearer

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

헤더

Idempotency-Keystring선택 사항<=255 characters

선택 사항이며 최대 255자입니다(더 길면 400 bad_request). 24시간 안에 같은 키로 동일한 요청을 보내면 첫 성공 응답을 Idempotent-Replayed: true와 함께 다시 반환합니다. 같은 키로 본문이나 경로가 다르면 409 idempotency_conflict를 반환하며, 첫 요청이 아직 실행 중인 키도 마찬가지입니다. 2xx가 아닌 응답은 저장되지 않습니다.

요청

This endpoint expects an object.
effect_idstring필수

GET /v1/effects에서 확인한, 공개된 고정 이펙트 ID입니다.

imageslist of strings필수

선택한 이펙트 버전이 요구하는 순서대로 나열한 공개 HTTPS 입력 이미지입니다. 정확한 개수와 허용되는 미디어 규칙은 GET /v1/effects/{effect_id}에서 확인하고, 로컬 파일은 POST /v1/files로 업로드하세요.

effect_versioninteger선택 사항>=1

변경되지 않는 버전을 선택적으로 지정합니다. 생략하면 현재 공개 버전을 사용합니다.

optionsobject선택 사항

선택한 이펙트 버전이 지원하는 선택 제어 항목입니다. 지원하지 않는 항목은 생략하세요. 기준은 카탈로그입니다.

응답

이펙트 작업 접수됨

dataobject

접수되었거나 현재의 BeatAPI 작업 상태입니다.

오류

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error