Enterprise API

Enterprise API เป็นฟีเจอร์ที่ช่วยให้คุณสามารถผสานรวมความสามารถระดับ Enterprise ของ Meshy เข้ากับแอปพลิเคชันของคุณเองได้ ฟีเจอร์ API เหล่านี้มีให้ใช้งานเฉพาะผู้ใช้ที่สมัครแผนระดับ enterprise ของเราเท่านั้น ในส่วนนี้ คุณจะพบข้อมูลทั้งหมดที่จำเป็นสำหรับการเริ่มต้นใช้งาน API นี้

GET/openapi/v1/showcases

List Showcases

เอนด์พอยต์นี้ช่วยให้คุณสามารถค้นหาและส่งคืนโมเดลตัวอย่างจากคอมมูนิตี้ที่พร้อมให้ดาวน์โหลดได้ คุณสามารถส่งคืนโมเดลได้สูงสุด 10 โมเดลต่อคำขอหนึ่งครั้ง และแต่ละคำขอจะมีค่าใช้จ่าย 1 เครดิต

พารามิเตอร์

แอตทริบิวต์ที่ไม่บังคับ

  • Name
    page_size
    Type
    integer
    Description

    จำนวนโมเดลตัวอย่างที่จะส่งคืน ต้องเป็นจำนวนบวกระหว่าง 1 ถึง 10 (รวมค่าทั้งสอง) โปรดทราบว่าอาจมีความเป็นไปได้ที่คำขอจะส่งคืนจำนวนโมเดลที่ตรงกันน้อยกว่าที่ร้องขอ หากมีโมเดลที่ตรงกันไม่เพียงพอ และจะไม่มีการส่งคืนโมเดลใดเลยหากไม่พบโมเดลที่ตรงกัน ค่าเริ่มต้นคือ 3 โมเดล หากไม่ระบุ page_size

  • Name
    sort_by
    Type
    string
    Description

    วิธีการจัดเรียงผลลัพธ์การค้นหาที่ได้รับ หากไม่ระบุ ผลลัพธ์จะถูกจัดเรียงตามเวลาที่สร้าง จากล่าสุดไปหาเก่าสุด (-created_at)

    • +created_at: จัดเรียงตามเวลาที่สร้างแบบเรียงจากน้อยไปมาก
    • -created_at: จัดเรียงตามเวลาที่สร้างแบบเรียงจากมากไปน้อย
    • +updated_at: จัดเรียงตามเวลาที่อัปเดตแบบเรียงจากน้อยไปมาก
    • -updated_at: จัดเรียงตามเวลาที่อัปเดตแบบเรียงจากมากไปน้อย
    • +downloads: จัดเรียงตามจำนวนดาวน์โหลดแบบเรียงจากน้อยไปมาก
    • -downloads: จัดเรียงตามจำนวนดาวน์โหลดแบบเรียงจากมากไปน้อย
  • Name
    search
    Type
    string
    Description

    ข้อความที่ต้องการค้นหาภายในชื่อโมเดลที่เผยแพร่ในคอมมูนิตี้ (CC0) หากไม่ระบุ จะส่งคืนโมเดลยอดนิยมโดยรวมของคอมมูนิตี้ (อิงตาม sort_by)

  • Name
    format
    Type
    string
    Description

    รูปแบบโมเดล 3 มิติที่ต้องการสำหรับผลลัพธ์ที่ส่งคืน โมเดลทั้งหมดที่ได้รับจะอยู่ในรูปแบบที่ระบุ ต้องเป็นหนึ่งในค่าที่ไม่บังคับด้านล่างนี้ หากไม่ระบุ จะเป็น glb โดยค่าเริ่มต้น

    • glb: รูปแบบ glb
    • fbx: รูปแบบ fbx
    • obj: รูปแบบ obj
    • usdz: รูปแบบ usdz
  • Name
    showcase_type
    Type
    string
    Description

    ประเภทโมเดลที่ต้องการสำหรับผลลัพธ์ที่ส่งคืน โมเดลทั้งหมดที่ได้รับจะอยู่ในประเภทที่ระบุ ต้องเป็นหนึ่งในค่าที่ไม่บังคับด้านล่างนี้ หากไม่ระบุ จะเป็น all โดยค่าเริ่มต้น

    • all: โมเดลตัวอย่างทั้งหมด
    • animated: โมเดลตัวอย่างที่มีแอนิเมชัน
    • static: โมเดลตัวอย่างแบบสแตติก

สิ่งที่ส่งคืน

  • Name
    id
    Type
    string
    Description

    ตัวระบุเฉพาะสำหรับโมเดลตัวอย่าง แม้ว่าเราจะใช้ k-sortable UUID เป็นรายละเอียดการใช้งานสำหรับ task id แต่คุณ ไม่ควร สันนิษฐานรูปแบบใดๆ สำหรับ id นี้

  • Name
    result_id
    Type
    string
    Description

    ตัวระบุเฉพาะสำหรับผลลัพธ์โมเดลที่ส่งคืน ID นี้เชื่อมโยงกับโมเดลและสามารถใช้ได้โดยตรงในงาน API อื่นๆ เช่น รีเมช

  • Name
    model_url
    Type
    object
    Description

    URL ของโมเดล 3 มิติที่สามารถดาวน์โหลดได้พร้อมเทกซ์เจอร์ ค่าเริ่มต้นจะส่งคืนในรูปแบบ glb

  • Name
    conversion_status
    Type
    string
    Description

    สถานะการแปลงประเภทไฟล์ของโมเดลที่ส่งคืน

    • <empty string>: ไม่ได้แปลง (ค่าเริ่มต้น glb)
    • success: แปลงสำเร็จ
    • failed: แปลงล้มเหลว
  • Name
    community_url
    Type
    string
    Description

    ลิงก์สำหรับเรียกดูในคอมมูนิตี้ของโมเดลตัวอย่าง

  • Name
    author
    Type
    string
    Description

    ผู้สร้างโมเดลตัวอย่าง

  • Name
    topology
    Type
    string
    Description

    topology ของโมเดลตัวอย่าง (quad หรือ triangle)

  • Name
    name
    Type
    string
    Description

    ชื่อของโมเดลตัวอย่าง

  • Name
    object_prompt
    Type
    string
    Description

    คำอธิบายของโมเดลตัวอย่าง

  • Name
    categories
    Type
    array
    Description

    หมวดหมู่ของโมเดลตัวอย่าง

  • Name
    tags
    Type
    array
    Description

    แท็กของโมเดลตัวอย่าง

  • Name
    mode
    Type
    string
    Description

    mode ของโมเดลตัวอย่าง

  • Name
    created_at
    Type
    timestamp
    Description

    ไทม์สแตมป์ของการสร้างโมเดลตัวอย่าง (มิลลิวินาที)

  • Name
    updated_at
    Type
    timestamp
    Description

    ไทม์สแตมป์ของการอัปเดตโมเดลตัวอย่าง (มิลลิวินาที)

Request

GET
/openapi/v1/showcases
curl "https://api.meshy.ai/openapi/v1/showcases?page_size=10&sort_by=-created_at&search=car&format=glb" \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "result": [
    {
      "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "result_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
      "model_url": "https://api.meshy.ai/v1/models/018a210d-8ba4-705c-b111-1f1776f7f578/model.glb",
      "conversion_status": "success",
      "community_url": "https://www.meshy.ai/showcase/018a210d-8ba4-705c-b111-1f1776f7f578",
      "author": "John Doe",
      "topology": "quad",
      "name": "Car",
      "object_prompt": "A car",
      "categories": ["vehicle"],
      "tags": ["car", "vehicle"],
      "mode": "3d",
      "created_at": 1717171717171,
      "updated_at": 1717171717171
    }
  ]
}