مستندات

مستندات API

راهنمای کامل برای یکپارچه‌سازی و استفاده از API هوش مصنوعی ویما. شروع سریع، نمونه کد و مرجع کامل API

شروع سریع

در کمتر از 5 دقیقه شروع به استفاده از API کنید

1

دریافت API Key

وارد حساب کاربری خود شوید و از بخش تنظیمات API Key خود را دریافت کنید.

2

نصب SDK

SDK مورد نظر خود را نصب کنید. ما SDK برای JavaScript، Python و Go ارائه می‌دهیم.

3

اولین درخواست

با استفاده از API Key خود، اولین درخواست را ارسال کنید.

نمونه کد

نمونه کدهای آماده برای شروع سریع

JavaScript
import { VimaClient } from '@vima/sdk';

const client = new VimaClient({
  apiKey: 'your-api-key'
});

const response = await client.chat.send({
  message: 'سلام، چطوری می‌تونم کمکت کنم؟'
});
Python
from vima import VimaClient

client = VimaClient(api_key='your-api-key')

response = client.chat.send(
    message='سلام، چطوری می‌تونم کمکت کنم؟'
)
cURL
curl -X POST https://api.vimaai.ir/v1/chat \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"message": "سلام"}'

مرجع API

لیست کامل endpoint های موجود

POST/v1/chat

ارسال پیام و دریافت پاسخ از دستیار هوشمند

POST/v1/image/generate

تولید تصویر با هوش مصنوعی

POST/v1/video/generate

تولید ویدیو با هوش مصنوعی

GET/v1/account/balance

دریافت موجودی سکه‌های Vim

احراز هویت

نحوه دریافت و استفاده از API Key

دریافت API Key

  1. 1وارد حساب کاربری خود شوید
  2. 2به بخش تنظیمات بروید
  3. 3API Key خود را ایجاد یا مشاهده کنید

استفاده از API Key

API Key خود را در header درخواست‌ها قرار دهید:

Authorization: Bearer your-api-key

آماده شروع هستید؟

API Key خود را دریافت کنید و شروع به ساخت کنید

دریافت API Key