این endpoint چه میکند؟
entityهای ساختاریافتهٔ قابل مشاهده را فهرست میکند؛ ممکن است فهرست عمومی فعلاً خالی باشد.
احراز هویت
عمومی یا مجاز بر اساس visibility. API رکوردهای خارج از scope را در پاسخ، search و direct ID نمایش نمیدهد.
پارامترها
| نام | محل | نوع | الزامی | توضیح |
|---|---|---|---|---|
| category | query | string | خیر | یکی از دستههای معتبر catalog. |
| type | query | string | خیر | نوع دانش؛ برای media معمولاً screenshot. |
| visibility | query | string | خیر | PUBLIC، INTERNAL، MANAGEMENT یا RESTRICTED؛ private filter مجوز میخواهد. |
| status | query | string | خیر | وضعیت رکورد؛ media بهطور پیشفرض current است. |
| limit | query | integer | خیر | پیشفرض ۲۰ و حداکثر ۱۰۰. |
| cursor | query | string | خیر | offset opaque برای صفحهٔ بعد؛ nextCursor را دوباره ارسال کنید. |
نمونهٔ درخواست
cURL
curl "https://luma-knowledge.pages.dev/api/v1/entities"نمونهٔ پاسخ
JSON
{
"data": [],
"pagination": {"limit": 20, "cursor": "0", "nextCursor": null, "total": 0}
}خطاهای مرتبط
400 invalid_query برای query نامعتبر و 404 not_found برای resource غیرقابل مشاهدهٔ احتمالی برگردانده میشود. شکل خطا در راهنمای خطا آمده است.
Try it
فقط درخواست GET عمومی؛ credential در مرورگر استفاده نمیشود.