Skip to main content
Referensi Open API Directing

Referensi API HappyOyster-Directing-Send Process Instruction

Kirim satu instruksi teks ke Travel mode standar untuk mendorong generasi frame selanjutnya. Hanya creationModel=simple yang didukung; Travel scriptlist harus menggunakan pembaruan skrip lengkap.

Cakupan

Kirim satu instruksi teks ke Travel mode standar (creationModel=simple) untuk mendorong generasi frame selanjutnya. Sebelum memanggil, konfirmasi 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: creationModel Travel harus simple, dan harus dalam status yang dapat menerima instruksi. Konfirmasi 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-directing/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-directing/openapi/v1/travels/instruct' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "content": "A giant robot dinosaur suddenly appears",
    "clientRequestId": "instruction_20260909_001",
    "userAgent": "your-client/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 Directing yang akan dikontrol; creationModel harus simple. Dikembalikan oleh Enter Travel.
content string (Wajib)Instruksi proses teks. Tidak boleh kosong, hingga 2000 karakter; mengembalikan 400000 ketika kosong atau melebihi 2000 karakter.
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": "A giant robot dinosaur suddenly appears",
        "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

  • Hanya creationModel=simple yang mendukung endpoint ini; Travel scriptlist harus menggunakan Full Script Update, dan memanggil instruct secara keliru akan mengembalikan 403006.
  • Status Travel saat ini harus dapat menerima instruksi; Travel yang telah berakhir atau gagal tidak dapat ditulis.
  • Ketika content kosong atau melebihi 2000 karakter, 400000 dikembalikan.
  • Sebaiknya buat clientRequestId yang stabil untuk setiap instruksi logis dan gunakan kembali saat mencoba ulang.
  • Jika instruksi gagal melewati kebijakan keamanan konten, 403004 akan dikembalikan.

Kode kesalahan

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

Langkah selanjutnya

Setelah mengirim instruksi:
Pembuatan Gambar
  • FAQ
Video Generation
Audio
  • Pembuatan audio
Realtime API
Penyematan Teks
TokenPlan
Model production