Skip to main content
Referensi Open API Acting

Referensi API HappyOyster-Acting-Send Process Instruction

Kirim satu instruksi teks ke Travel Acting untuk mendorong permainan peran dan pembuatan frame selanjutnya. Dapat dipanggil saat Travel sedang berjalan atau dijeda.

Cakupan

Kirim satu instruksi teks ke Travel Acting untuk mendorong permainan peran dan pembuatan frame selanjutnya. Sebelum memanggil, pastikan 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: Status Travel harus running atau paused. Konfirmasikan melalui Query Travel Status.
  • 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/instructGanti {WorkspaceId} dengan ID Workspace Anda yang sebenarnya.

Parameter permintaan

  • Kirim instruksi proses
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "Smile and greet me, and ask how my day is going",
    "clientRequestId": "instruction_greeting_001",
    "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 Acting terenkripsi yang akan dikontrol. Dikembalikan oleh Enter Travel.
content string (Wajib)Instruksi proses teks. Tidak boleh kosong, hingga 2000 karakter; mengembalikan 400000 jika hilang, kosong, atau melebihi batas.
clientRequestId string (Opsional)Kunci idempotensi untuk percobaan ulang instruksi. Gunakan kembali nilai yang sama saat mencoba ulang instruksi yang sama untuk menghindari penagihan ganda. Format yang disarankan [A-Za-z0-9_-]{1,32}.
  • Jika dihilangkan atau formatnya salah, tidak akan mengembalikan kesalahan parameter: server akan kembali menggunakan request_id gateway, dan menggunakan kunci idempotensi acak jika hal tersebut masih tidak tersedia
  • Kolom ini hanya digunakan untuk deduplikasi penagihan; kolom ini tidak menjamin bahwa pemrosesan instruksi itu sendiri berjalan tepat satu kali
userAgent string (Opsional)Pengidentifikasi versi SDK atau klien. String tidak kosong; didahulukan daripada HTTP User-Agent.

Parameter respons

  • Instruksi diterima
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "content": "Smile and greet me, and ask how my day is going",
        "accepted": true
    }
}
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 yang terenkripsi.content stringTeks instruksi yang diterima.accepted booleanApakah instruksi telah diterima dan masuk ke alur pemrosesan.

Status prasyarat dan catatan pemanggilan

  • Status Travel harus running atau paused.
  • content wajib diisi dan tidak boleh kosong atau hanya berisi karakter spasi, dengan panjang maksimal 2000 karakter.
  • Mengirim instruksi dalam status paused hanya menerima instruksi tersebut dan tidak secara otomatis melanjutkan Travel; ketika Anda perlu melanjutkan pelaksanaan, klien harus memanggil Resume Travel secara terpisah.
  • Gunakan kembali clientRequestId saat mencoba ulang instruksi logis yang sama untuk menghindari penagihan ganda.
  • Travel yang telah berakhir atau gagal tidak dapat ditulisi.
  • Jika instruksi gagal melewati kebijakan keamanan konten, 403004 akan dikembalikan.
  • creationModel Acting selalu bernilai simple, sehingga tidak perlu mempertimbangkan sub-mode ScriptList.

Kode kesalahan

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

Langkah selanjutnya

Setelah mengirim instruksi:
Penggunaan API
Generasi teks
Pembuatan Gambar
  • FAQ
Video Generation
Model Dunia
Audio
  • Pembuatan audio
Real-time multimodal
Realtime API
Penyematan Teks
Lainnya Model
Toolkit/Framework
TokenPlan
Model production
Manajemen file
Penagihan
Manajemen Model
Lebih Banyak Tentang Model