AZ
Mövzunu seçin:

API Sənədləşdirmə

Softyu Office tətbiqlərinizə inteqrasiya edin. Tapşırıqlara, agentlərə, fayllara və iş sahəsi məlumatlarına proqramlı şəkildə daxil olun.

Baza URL
https://office.softyu.org/api/v1
Versiya
v1

Doğrulama

Bütün API sorğuları etibarlı API açarı tələb edir. Açarınızı daxil edin Authorization Başlıq Daşıyıcı nişanı kimi.

// HTTP başlığı
Authorization: Bearer so_live_your_api_key_here
API açarınızı necə əldə etmək olar: gedin Parametrlər → API Düymələr seçin və "API Açar yarat" üzərinə klikləyin. Onu təhlükəsiz saxlayın - nəsildən sonra onu bir daha görə bilməyəcəksiniz.
// cURL sorğusu nümunəsi
curl -X GET https://office.softyu.org/api/v1/tasks \
  -H "Authorization: Bearer so_live_7cf8a9b2e1d4..." \
  -H "Content-Type: application/json"

Tapşırıqlar

İş məkanınızda AI agent tapşırıqlarını yaradın, siyahıya salın və idarə edin.

Yaradılma tarixinə görə sıralanmış iş məkanında tapşırıqların səhifələnmiş siyahısını qaytarır (əvvəl ən yeni).

ParametrNövTəsvir
limitintegerQaytarılacaq maksimum nəticələr (defolt: 50, maksimum: 200)
statusstringVəziyyətə görə süzün: gözləyən, işləyir, tamamlandı, xəta
offsetintegerSəhifə ofseti (defolt: 0)
// Cavab 200
{
  "tasks": [
    {
      "id": 42,
      "title": "Write blog post about AI trends",
      "status": "completed",
      "priority": 5,
      "agent": "Content Writer",
      "created_at": "2026-06-10T14:30:00Z"
    }
  ],
  "total": 156
}

Yeni tapşırıq yaradın və onu AI agentinə təyin edin.

SahəsiNövTələb olunurTəsvir
titlestringBəliTapşırıq başlığı (maks. 500 simvol)
descriptionstringBəliTapşırığın ətraflı təsviri
agent_idintegerXeyrTəyin ediləcək agentin ID-si
priorityintegerXeyrPrioritet səviyyəsi 1-10 (defolt: 5)
// Sorğu gövdəsi
{
  "title": "Analyze Q2 sales data",
  "description": "Process the Q2 CSV and generate summary",
  "agent_id": 3,
  "priority": 8
}

Nəticə, xəta mesajı və əlaqəli fayllar daxil olmaqla, konkret tapşırığın tam təfərrüatlarını qaytarır.

Agentlər

İş yerinizdə AI agentləri siyahıya alın və idarə edin.

Hazırda iş sahəsi komandanızda olan bütün AI agentləri qaytarır.

// Cavab 200
{
  "agents": [
    {
      "id": 3,
      "name": "Content Writer",
      "role": "content",
      "status": "active"
    }
  ]
}

Söhbət

İş yerində söhbət mesajları yaradın və söhbət tarixçəsini əldə edin.

SahəsiNövTələb olunurTəsvir
messagestringBəliMesaj məzmunu
agent_idintegerXeyrBirbaşa mesaj üçün hədəf agent
ParametrNövTəsvir
limitintegerMaks. mesajlar (defolt: 50)
agent_idintegerXüsusi agent DM ilə süzün

Fayllar

AI agentləri tərəfindən yaradılan fayllara daxil olun.

İş məkanınızdakı bütün yaradılan faylları yükləmə nişanları ilə qaytarır.

Unikal endirmə nişanından istifadə edərək faylı endirin. Müvafiq MIME növü ilə fayl ikilisini qaytarır.

İş sahəsi

İş sahəsi haqqında məlumat və statistika əldə edin.

// Cavab 200
{
  "name": "My Workspace",
  "company": "Softyu LLC",
  "plan": "pro",
  "agents_count": 5,
  "tasks_count": 156,
  "storage_used_mb": 245.8
}

İstifadə İzlənməsi

Hər bir təsdiqlənmiş API sorğusu Parametrlərdə göstərilən API açarı üçün istifadə sayğacını artırır. Tapşırıq yaradılması hələ də iş sahəsi planının gündəlik tapşırıq limitinə uyğundur.

API Açar
İstifadəsi
sorğuya görə hesablanır
Tapşırıqlar
Plan
gündəlik tapşırıq limiti tətbiq olunur
Fayllar
Token
iş yeri açarı tələb olunur
Ləğv edilmiş API açarları dərhal 401 cavabı qaytarır. Açarları burada yaradın və ya ləğv edin: Ayarlar → API açarları.

Səhv Kodları

Standart HTTP xəta kodları istifadə olunur. Xəta cavablarına təfərrüatları olan JSON korpus daxildir.

KodVəziyyətiTəsvir
400Səhv SorğuYanlış sorğu əsası və ya çatışmayan tələb olunan sahələr
401İcazəsizÇatışmayan və ya etibarsız API açarı
403QadağandırAPI açarının bu resursa girişi yoxdur
404TapılmadıResurs tapılmadı
500Server xətasıDaxili server xətası — dəstək xidməti ilə əlaqə saxlayın
// Xəta cavabının formatı
{
  "error": "Unauthorized",
  "message": "Invalid or expired API key",
  "code": 401
}