Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-End Travel

Mengakhiri Travel Acting secara aktif. Setelah pengakhiran normal, Travel memasuki status completed dan mulai memproses artefak; pada pengakhiran batas waktu tanpa stream, Travel memasuki status failed dan tidak ada artefak replay yang dihasilkan.

Cakupan

Mengakhiri Travel Acting secara aktif. Setelah pengakhiran normal, Travel memasuki completed dan mulai memproses artefak; pada pengakhiran batas waktu tanpa stream, Travel memasuki failed dan tidak ada artefak replay yang dihasilkan. Sebelum memanggil, konfirmasikan hal berikut:
  • Autentikasi: Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya. Untuk cara mendapatkannya, lihat Mendapatkan kredensial autentikasi.
  • Prasyarat: Travel belum boleh memasuki status terminal dan harus berada dalam status yang dapat diakhiri oleh server. Konfirmasikan melalui Kueri Status Travel.
  • Pemanggil: Server atau klien Anda dapat memanggilnya.

Permintaan HTTP

  • Singapore
  • AS (Virginia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/endGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Pengakhiran normal
  • Pengakhiran batas waktu tanpa stream
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/end' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/1.2.0"
}'
Content-Typestring(Wajib)Tipe konten permintaan. Parameter ini harus diatur ke application/json.
Authorization string (Wajib)Autentikasi Kunci API. Kunci API utama tidak wajib; kunci API utama atau sementara dapat digunakan untuk memanggilnya.
  • API Key Utama: dimulai dengan sk-, misalnya sk-xxx.
  • Kunci API Sementara: diawali dengan st-, misalnya st-xxx.
Request Body
encryptedTravelId string (Wajib)ID Travel terenkripsi Acting yang akan diakhiri. Dikembalikan oleh Masuk Travel.
failCode string (Opsional)Alasan pengakhiran kegagalan karena batas waktu tanpa stream. Jika dihilangkan, hal ini dianggap sebagai pengakhiran normal. Saat ini hanya mendukung:
  • TRAVEL_NO_STREAM_AUTO_END: untuk skenario ketika tidak ada stream yang diterima setelah masuk ke room selama lebih dari noStreamAutoEndTimeoutSec; jenis pengakhiran ini tidak menghasilkan artefak replay
Meneruskan nilai yang tidak didukung akan mengembalikan 400000.
userAgent string (Opsional)Pengidentifikasi versi SDK atau klien. String tidak kosong; didahulukan daripada HTTP User-Agent.

Parameter respons

  • Pengakhiran normal
  • Pengakhiran batas waktu tanpa stream
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "completed",
        "endedAt": "2026-09-09T08:33:00Z",
        "durationSec": 180
    }
}
code integerKode pengembalian. 0 berarti berhasil; bukan nol adalah kode kesalahan.
message stringPesan kesalahan. null jika berhasil.
data objectData respons. null jika gagal.

Properti

encryptedTravelId stringID Travel terenkripsi yang telah diakhiri.status stringStatus akhir:
  • completed: berakhir normal
  • failed: pengakhiran karena kegagalan ketika failCode yang didukung disediakan
errorCode stringKode alasan kegagalan; hanya dikembalikan pada pengakhiran karena kegagalan.errorMessage stringDeskripsi kegagalan; hanya dikembalikan pada pengakhiran karena kegagalan.endedAt stringWaktu berakhir, dalam format ISO 8601; dapat berupa null jika belum tersedia.durationSec integerDurasi video efektif dalam detik; null pada pengakhiran kegagalan tanpa stream atau ketika durasi belum dapat diuraikan.

Status prasyarat dan catatan pemanggilan

  • encryptedTravelId harus dimiliki oleh akun utama saat ini dan model Acting.
  • Travel belum boleh memasuki status terminal dan harus berada dalam status yang dapat diakhiri oleh server.
  • Jika failCode dihilangkan, hal ini dianggap sebagai pengakhiran normal; meneruskan nilai yang tidak didukung akan mengembalikan 400000.
  • Pada pengakhiran normal, durationSec secara prioritas menggunakan durasi aktual dari video jadi yang tersedia; nilainya mungkin null jika durasi video jadi belum dapat diuraikan.
  • Acting tidak menggunakan maxExperienceTimeSec dan tidak akan mengakhiri secara otomatis setelah durasi tersebut ketika klien meneruskannya.
  • Setelah pengakhiran normal mencapai completed, artefak komposit mungkin masih diproses; kueri dan lakukan polling terhadapnya sesuai Kueri Artefak Travel.

Kode kesalahan

Jika pemanggilan model gagal dan mengembalikan kesalahan, lihat Kode Kesalahan HappyOyster untuk menyelesaikannya.

Langkah selanjutnya

Setelah Travel memasuki status completed:
Pembuatan Gambar
  • FAQ
Video Generation
Audio
  • Pembuatan audio
Realtime API
Penyematan Teks
TokenPlan
Model production