คีย์ API
สร้างคีย์สำหรับ API กำหนดขอบเขต และจัดการมัน
คีย์ API ใช้ยืนยันตัวตนของคำขอที่ส่งไปยัง Open API ของ Reverie คีย์อยู่ที่ การตั้งค่า → เพิ่มเติม → คีย์ API ซึ่งเป็นที่เดียวกับที่ช่อง Open API ใน Labs ชี้ไป บัญชีไหนก็สร้างได้ — ไม่มีเงื่อนไขเรื่องระดับ และไม่จำกัดว่าคุณจะถือไว้กี่อัน
สร้างคีย์
กด «สร้างคีย์ API ใหม่»
ถ้าหน้ายังว่างอยู่ ปุ่มจะเขียนว่า สร้างคีย์ API แรกของคุณ
ตั้งชื่อให้มัน
ชื่อ เป็นข้อมูลที่ต้องกรอก ยาว 1–100 ตัวอักษร มันคือป้ายกำกับของคีย์ในรายการและในสถิติการใช้งาน เช่น "ลำโพงห้องนั่งเล่น" หรือ "staging worker"
เลือกทั่วไปหรือตัวละครเฉพาะ
การเลือกตัวละคร คือการเลือกระหว่าง ทั่วไป (ตัวละครทั้งหมด) กับ ตัวละครเฉพาะ ไม่ใช่ของแถมที่จะข้ามก็ได้ ตัวละครที่เลือกจะกลายเป็นตัวละครที่ตรึงไว้กับคีย์นั้น
จะตั้งประเภทอุปกรณ์และวันหมดอายุด้วยก็ได้
ประเภทอุปกรณ์ เป็นข้อความอิสระ (speaker, phone, iot) ส่วน วันหมดอายุ ต้องใส่ทั้งวันที่และเวลา พอถึงเวลานั้นคีย์จะหยุดทำงานเอง
คีย์จะปรากฏขึ้นทันที เป็น rk_ ตามด้วยอักขระฐานสิบหก 64 ตัว
คีย์ดูย้อนหลังได้เสมอ
ความลับนี้ไม่ได้แสดงครั้งเดียวแล้วหาย ตราบที่คีย์ยังอยู่ การ์ดของมันจะมี แสดงคีย์ API, ซ่อนคีย์ API และ คัดลอกคีย์ API ให้ใช้ได้ตลอดเวลา
ในเมื่อความลับฉบับเต็มยังอ่านได้จากหน้าการตั้งค่าของคุณ ก็ให้ถือว่าการเข้าถึงบัญชีเท่ากับการเข้าถึงคีย์ เก็บคีย์ไว้บนเซิร์ฟเวอร์หรือในตัวจัดการความลับ อย่าเอาไปไว้ในระบบควบคุมเวอร์ชันหรือในโค้ดฝั่งเบราว์เซอร์เด็ดขาด
คีย์ทั่วไปกับคีย์ที่ตรึงตัวละคร
| ทั่วไป (ตัวละครทั้งหมด) | ตัวละครเฉพาะ | |
|---|---|---|
GET /models คืนอะไร | ตัวละครล่าสุดของคุณ | ฉากสถานการณ์ของตัวละครนั้น หรือถ้าไม่มีเลยก็คืนตัวละครเอง |
ไม่ใส่ model | ถอยไปใช้แชทล่าสุดของคุณ | ใช้ตัวละครที่ตรึงไว้ |
| ไอดีฉากแบบสั้น | ไม่มีวันแปลผลได้ | แปลผลภายใต้ตัวละครที่ตรึงไว้ |
ปิดใช้งาน ลบ และหมุนเวียน
| การกระทำ | ผล | ย้อนกลับได้ไหม |
|---|---|---|
| สวิตช์ ใช้งานอยู่ | ระหว่างที่ปิดอยู่ คำขอที่ใช้คีย์นี้จะถูกปฏิเสธ | ได้ |
| ลบ | คีย์ถูกทำลาย และแอปที่ใช้มันอยู่จะเข้าถึงไม่ได้อีก | ไม่ได้ |
ไม่มีปุ่มเพิกถอนแยกต่างหาก — มีแค่ปิดใช้งานกับลบ สองทางนี้เท่านั้น
การลบคีย์ย้อนกลับไม่ได้ และมันพาที่มาของคีย์นั้นหายไปด้วย ทราฟฟิกเก่าของมันจะย้ายไปอยู่ในกลุ่ม คีย์ที่ถูกลบ ในสถิติการใช้งาน ซึ่งคุณจะแยกไม่ออกอีกแล้วว่าการเชื่อมต่อไหนใช้ไปเท่าไร ถ้าคิดว่าอาจยังต้องการประวัติอยู่ ให้ปิดใช้งานมันก่อน
เวลาจะหมุนเวียนคีย์ ให้สร้างอันใหม่ขึ้นมาแทน นำไปใช้งานจริง แล้วค่อยปิดหรือลบอันเก่า ไม่มีการหมุนเวียนอัตโนมัติ และหมดอายุแล้วก็ไม่มีช่วงผ่อนผัน — คีย์ที่หมดอายุจะถูกปฏิเสธด้วย api_key_expired ตั้งแต่คำขอถัดไป
ขอบเขตสิทธิ์
คีย์มีขอบเขตสิทธิ์ติดมาด้วย แต่กล่องสร้างคีย์ไม่ได้แสดงมันออกมา คีย์ที่คุณสร้างในหน้าการตั้งค่าเรียกได้เฉพาะปลายทางที่เกี่ยวกับแชทเท่านั้น
ปลายทางนำเข้าตัวละครต้องใช้ขอบเขตสิทธิ์อีกแบบ และทางเดียวที่จะได้คีย์แบบนั้นคือเปิด Labs → ทักษะนำเข้าตัวละคร ซึ่งจะสร้างให้คุณหนึ่งอัน ชื่อว่า Reverie Character Importer (Skill) ถ้าเรียกตัวนำเข้าด้วยคีย์ธรรมดาจากหน้าการตั้งค่า จะได้ 403 กลับมา นำเข้าตัวละคร →
สถิติการใช้งาน
แผง สถิติการใช้งาน บนหน้าเดียวกันจะรายงาน คำขอ, โทเค็น, เครดิต และ คีย์ที่ใช้งานอยู่ โดยแบ่งตามวัน UTC พร้อมรายละเอียดรายคีย์ใต้หัวข้อ การใช้งานตามคีย์ กรองตามคีย์อันเดียวหรือเลือก คีย์ทั้งหมด ก็ได้ ภายในช่วง 7 ถึง 90 วัน — ค่าเริ่มต้นคือ 30 วัน และนับเฉพาะแชทที่สร้างผ่าน API เท่านั้น
แผงนี้เป็นที่เดียวที่มียอดใช้จ่ายรายคีย์อยู่ ประวัติเครดิตของคุณบันทึกว่าแต่ละข้อความราคาเท่าไร แต่ไม่ได้ระบุว่ารายการนั้นมาจากคีย์ไหน ดังนั้นถ้าจะเทียบการเชื่อมต่อแต่ละอัน ให้ใช้สถิติตรงนี้
สร้างคำขอ
สร้างคำขอ จะเปิดตัวช่วยสร้าง เลือกคีย์ที่ใช้งานอยู่สักอัน เลือกตัวละครหรือฉากสถานการณ์จากรายการที่คีย์นั้นมองเห็น พิมพ์ข้อความ เลือกว่าจะสตรีมไหมและค่า temperature เท่าไร แล้วคัดลอกโค้ด cURL, TypeScript หรือ Python ที่ใช้ได้จริงไปเลย
คีย์ถูกใช้ในเบราว์เซอร์ของคุณเพียงเพื่อโหลดรายการตัวละครเท่านั้น ส่วนโค้ดที่สร้างออกมาจะอ่าน REVERIE_API_KEY จากตัวแปรสภาพแวดล้อม แทนที่จะฝังความลับไว้ข้างใน
ขีดจำกัด
| ขีดจำกัด | ค่า |
|---|---|
| คีย์ต่อบัญชี | ไม่จำกัด |
| ขีดจำกัดอัตราต่อคีย์ | ไม่มี |
| เพดานการเรียกพร้อมกันต่อคีย์ | ไม่มี |
| อะไรที่จำกัดการใช้งานจริง ๆ | ยอดเครดิตคงเหลือของคุณ บวกกับช่วงโควตาโมเดลฟรี |
ที่เกี่ยวข้อง
- Open API — ปลายทาง รูปแบบคำขอ และข้อผิดพลาด
- นำเข้าตัวละคร — คีย์สำหรับนำเข้ามีไว้ทำอะไร
- Reverie Labs — ช่อง Open API และช่องนำเข้า
- ความปลอดภัย — การตั้งค่าการเข้าถึงอื่น ๆ ของบัญชีคุณ