مرجع API
promptهای پروژه
promptهای پرکاربرد را در همان پروژه‌ای نگه دارید که از آن‌ها استفاده می‌کند. نسخه‌ها را مدیریت کنید و promptهایی را که دیگر نباید انتخاب شوند بایگانی کنید.
روند کار
روی هر عملیات بزنید تا همهٔ ورودی‌ها، request، response و کدهای وضعیت آن را ببینید.
ساخت prompt پروژه
POST
/api/v1/tenancy/projects/{project_id}/promptsآدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
نوع محتوا
application/jsonپارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
body | Body | string | الزامی | مخصوص مهوش | متن prompt با طول محدود. |
description | Body | string | اختیاری | مخصوص مهوش | توضیح prompt. |
name | Body | string | الزامی | مخصوص مهوش | نام prompt. |
Request
curl -X POST 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/prompts' \
-H "Authorization: Bearer $MAHVASH_USER_JWT" \
-H "Content-Type: application/json" \
-d '{
"body": "Cite every source.",
"name": "Research rules"
}'Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 201 | منبع ساخته شد. |
| 400 | request نامعتبر است. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 409 | تداخل در وضعیت یا idempotency. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
دریافت prompt پروژه
GET
/api/v1/tenancy/projects/{project_id}/prompts/{prompt_id}آدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
پارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
prompt_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID مربوط به prompt. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
Request
curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/prompts/<prompt_id>' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
ویرایش prompt پروژه و ساخت نسخهٔ تازه
PATCH
/api/v1/tenancy/projects/{project_id}/prompts/{prompt_id}آدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
نوع محتوا
application/jsonپارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
prompt_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID مربوط به prompt. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
body | Body | string | اختیاری | مخصوص مهوش | متن جدید prompt. |
description | Body | string | اختیاری | مخصوص مهوش | توضیح جدید prompt. |
name | Body | string | اختیاری | مخصوص مهوش | نام جدید prompt. |
Request
curl -X PATCH 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/prompts/<prompt_id>' \
-H "Authorization: Bearer $MAHVASH_USER_JWT" \
-H "Content-Type: application/json" \
-d '{
"body": "Cite every source."
}'Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 400 | request نامعتبر است. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 409 | تداخل در وضعیت یا idempotency. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
بایگانی prompt پروژه
DELETE
/api/v1/tenancy/projects/{project_id}/prompts/{prompt_id}آدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
پارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
prompt_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID مربوط به prompt. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
Request
curl -X DELETE 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/prompts/<prompt_id>' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
این endpoint بدنهٔ JSON برنمی‌گرداند یا خروجی آن فایل باینری است.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 204 | response محتوایی ندارد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |
فهرست promptهای پروژه
GET
/api/v1/tenancy/projects/{project_id}/promptsآدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
پارامترها
این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر می‌کند و هرگز دسترسی بیشتری نمی‌دهد. |
Request
curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/prompts' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان می‌دهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 400 | request نامعتبر است. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کرده‌اید. |
| 500 | خطای داخلی سرور. |