Open API

Reverie เปิดปลายทาง Chat Completions ที่เข้ากันได้กับ OpenAI ชี้ไคลเอนต์ OpenAI ตัวไหนก็ได้มาที่นี่ ส่งคีย์ API ของ Reverie ไปด้วย แล้วใช้ฟิลด์ model ระบุตัวละครหรือฉากสถานการณ์แทนที่จะเป็นโมเดลภาษา บทสนทนา ความทรงจำ และบทสรุปทั้งหมด Reverie เก็บไว้ฝั่งของมันเอง ดังนั้นแต่ละคำขอจึงต้องการแค่ข้อความใหม่ของคุณ

บัญชีที่ลงชื่อเข้าใช้แล้วใช้ได้ทุกบัญชี ไม่มีระดับการสมัครสมาชิกและไม่มีรายชื่อรอคิว — คุณต้องมีคีย์ API เท่านั้น แค่นั้นเอง สร้างสักอัน →

URL หลักและการยืนยันตัวตน

https://reverie.im/api/device/v1
Authorization: Bearer rk_...

การตั้งค่า → เพิ่มเติม → คีย์ API จะแสดง URL หลักที่ถูกต้องในการ์ด API Endpoint พร้อมปุ่มคัดลอก

เริ่มใช้งานอย่างรวดเร็ว

curl --no-buffer https://reverie.im/api/device/v1/chat/completions \
  -H "Authorization: Bearer $REVERIE_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary '{
  "model": "Luna [abc12345]",
  "messages": [
    {
      "role": "user",
      "content": "Hi"
    }
  ],
  "stream": true,
  "temperature": 0.8
}'

การตั้งค่า → เพิ่มเติม → คีย์ API ยังมีตัวสร้างคำขอ ที่จะสร้างโค้ดทั้งสามชุดนี้จากคีย์จริงอันหนึ่งของคุณกับตัวละครจริง

ฟิลด์ model ระบุตัวละคร

รายละเอียดที่ตัดสินว่าไอดีสั้นจะถูกแปลผลได้หรือไม่

• [...] ต้องอยู่ท้ายสตริง
• ส่วนท้ายที่ยาวไม่เกิน 8 ตัวอักษรจะถูกจับคู่เฉพาะกับตัวละครที่คุณมีแชทด้วยอยู่แล้ว ไม่ว่าจะบนเว็บหรือผ่าน API ส่วนไอดีสั้นของตัวละครที่คุณไม่เคยเปิดเลยจะหลุดไปเงียบ ๆ
• การค้นหาฉากสถานการณ์จะทำงานเฉพาะเมื่อคีย์ถูกตรึงไว้กับตัวละครเท่านั้น ถ้าใช้คีย์ทั่วไป ไอดีฉากแบบสั้นจะแปลผลไม่ได้เลย
• ถ้ายาวเกิน 8 ตัวอักษร จะถูกถือว่าเป็นไอดีเต็ม

ดูว่าคุณคุยกับอะไรได้บ้าง

curl https://reverie.im/api/device/v1/models \
  -H "Authorization: Bearer $REVERIE_API_KEY"

คีย์แบบทั่วไปจะคืนตัวละครล่าสุดของคุณ ส่วนคีย์ที่ตรึงไว้กับตัวละครจะคืนฉากสถานการณ์ของตัวละครนั้นแทน หรือคืนตัวละครเองถ้ามันไม่มีฉากเลย แต่ละรายการหน้าตาแบบนี้

{
	"id": "Luna [abc12345]",
	"object": "model",
	"created": 1759200000,
	"owned_by": "character",
	"permission": [],
	"root": "<full character id>",
	"parent": null
}

คัดลอก id ไปใส่ใน model ได้เลย ข้อผิดพลาดจากปลายทางนี้ใช้รูปแบบข้อผิดพลาดแบบเรียบ ๆ ไม่ใช่กรอบของ OpenAI

เนื้อคำขออ่านอะไรบ้าง

มีสี่ฟิลด์ที่ถูกอ่าน นอกนั้นรับไว้แล้วทิ้งเงียบ ๆ

ถูกเพิกเฉยโดยไม่เตือน max_tokens, top_p, n, stop, presence_penalty, frequency_penalty, logit_bias, seed, user, response_format, tools, tool_choice, logprobs, stream_options.

messages ถูกจัดการอย่างไร

• ข้อความ system จะถูกทิ้ง บุคลิกและพฤติกรรมมาจากฟิลด์ของตัวละครเอง ไม่ใช่จากคำขอ ฟิลด์ของพรอมต์ →
• ไม่รองรับการมองภาพ เนื้อหาจะเป็นสตริงหรืออาร์เรย์ของส่วนย่อยก็ได้ แต่อ่านเฉพาะส่วนที่เป็น text เท่านั้น ส่วนที่เป็นรูปภาพจะถูกเพิกเฉย
• มีเพียงข้อความ user ข้อความสุดท้ายเท่านั้นที่จะถูกเพิ่มเข้าบทสนทนา ข้อความของผู้ใช้ก่อนหน้านั้นจะถูกเพิกเฉย
• ข้อความของผู้ช่วยถูกใช้เพื่อซิงก์ประวัติเท่านั้น (ดูด้านล่าง)
• ถ้าข้อความสุดท้ายของผู้ใช้ว่างเปล่าหรือมีแต่ช่องว่าง จะได้ missing_user_message กลับมา

การตอบกลับ

การตอบกลับแบบไม่สตรีมคืออ็อบเจกต์ chat.completion ปกติ โดย finish_reason จะเป็น stop เสมอ — การเรียกเครื่องมือภายในไม่เคยถูกเปิดออกมา — และตัวนับใน usage เป็นศูนย์ทั้งหมด ดังนั้นให้วัดโทเค็นจากสถิติการใช้งานในหน้าคีย์ API แทนที่จะดูจากการตอบกลับ

การตอบกลับแบบสตรีมคือ text/event-stream

1. ก้อนเนื้อหา คืออ็อบเจกต์ chat.completion.chunk ที่มี delta.content จะไม่มีการส่งก้อนแรกแบบ delta: {"role": "assistant"}
2. ก้อนปิดท้าย ที่มี finish_reason เป็น stop, length หรือ content_filter ส่วนการจบเพราะเรียกเครื่องมือจะรายงานเป็น stop
3. ก้อนการใช้งาน ที่มีอาร์เรย์ choices ว่างเปล่า
4. data: [DONE].

ถ้าการสร้างล้มเหลวกลางสตรีม สตรีมจะส่ง data: {"error": {...}} ออกมาแล้วตามด้วย [DONE]

สถานะของบทสนทนา

Reverie เป็นฝ่ายเก็บบทสนทนาไว้เอง ทุกคู่ของคีย์กับตัวละครจะมีแชทหนึ่งรายการ แชทนั้นจะโผล่ในเว็บแอปเคียงกับแชทอื่น ๆ ของคุณ และแต่ละตาจะประกอบขึ้นจากพรอมต์ระบบและฉากสถานการณ์ของตัวละคร ข้อกำหนดจากสมุดโลก ความทรงจำระยะยาว บทสรุปที่ทยอยสะสม สไตล์การเล่าเรื่องของตัวละคร ความยาวคำตอบและการตั้งค่า NSFW การล็อกภาษาจากภาษาของบัญชีคุณ และประวัติล่าสุดเท่าที่หน้าต่างบริบทของโมเดลจะรับไหว ส่วนเครื่องมือด้านความทรงจำจะทำงานเมื่อโมเดลรองรับเครื่องมือ

เพราะเซิร์ฟเวอร์เก็บประวัติไว้ให้แล้ว คุณจึงไม่ต้องส่งมันซ้ำ

โมเดลภาษาตัวไหนเป็นคนตอบ

ตัวละครเป็นคนกำหนด ไม่ใช่คำขอ — ยกเว้นว่าคุณระบุโมเดลภาษาเอง ลำดับความสำคัญจากต่ำไปสูงคือ โมเดลแชทเริ่มต้น แล้วค่าโมเดลที่ตั้งไว้ของตัวละครเอง แล้ว ID โมเดลของ Reverie ที่ส่งมาใน model และสุดท้ายคือความชอบด้านโมเดลที่คุณตั้งไว้สำหรับแชทนั้นในเว็บแอป ซึ่งชนะทุกอย่างข้างต้น โมเดล →

ข้อผิดพลาด

ข้อผิดพลาดจาก /chat/completions ใช้กรอบของ OpenAI {"error": {"message", "type", "param": null, "code"}}.

มีสองกรณีที่อยู่นอกกรอบนี้ คือข้อผิดพลาดของ GET /models และเนื้อคำขอที่ถูกการตรวจสอบปฏิเสธ (เช่น temperature นอกช่วง) — ทั้งสองกรณีจะคืนรูปแบบข้อผิดพลาดแบบเรียบ ๆ

ขีดจำกัดอัตราและโควตา

API นี้ ไม่มีขีดจำกัดอัตราต่อคีย์ ไม่มีเพดานการเรียกพร้อมกัน และไม่มีโควตาคำขอ มีเพียงสองอย่างที่จำกัดการใช้งานของคุณ

ช่วงโควตาโมเดลฟรีใช้ร่วมกับแชทบนเว็บ เรื่องราว นิยาย และบอททั้งหลาย — มันเป็นโควตาเดียวต่อบัญชี ไม่ใช่โควตาแยกของแต่ละช่องทาง โมเดลฟรี →

Reverie ไม่ส่ง webhook ออกไปข้างนอก จึงไม่มีอะไรให้สมัครรับเพื่อรู้ว่าการสร้างเสร็จแล้ว

การนำเข้าตัวละคร

ยังมีปลายทางที่สอง POST /api/v1/characters/import ซึ่งสร้างตัวละครจากการ์ดตัวละคร มันต้องใช้คีย์ที่มีสิทธิ์นำเข้า ซึ่งไม่ใช่ชนิดของคีย์ที่หน้าการตั้งค่าสร้างให้ คีย์ API → และ นำเข้าตัวละคร →

ที่เกี่ยวข้อง

• คีย์ API — สร้าง ตรึง กำหนดวันหมดอายุ และดูการใช้งานของคีย์
• โมเดล — ID ของโมเดลและตัวคูณเครดิต
• ขีดจำกัด — เพดานอื่น ๆ ในผลิตภัณฑ์
• เครดิต — คำขอถูกคิดราคาอย่างไร