TR
Tema seçin:

API Belgeler

Softyu Office uygulamasını uygulamalarınıza entegre edin. Görevlere, aracılara, dosyalara ve çalışma alanı verilerine programlı olarak erişin.

Baz URL
https://office.softyu.org/api/v1
Sürüm
v1

Kimlik Doğrulaması

Tüm API istekleri geçerli bir API anahtarı gerektirir. Anahtarınızı şuraya ekleyin: Authorization Taşıyıcı belirteci olarak başlık.

// HTTP başlığı
Authorization: Bearer so_live_your_api_key_here
API anahtarınızı nasıl alırsınız: Git Ayarlar → API Tuşları yazın ve "API Anahtarı Oluştur"a tıklayın. Güvenli bir şekilde saklayın; nesiller sonra onu bir daha göremeyeceksiniz.
// Örnek cURL isteği
curl -X GET https://office.softyu.org/api/v1/tasks \
  -H "Authorization: Bearer so_live_7cf8a9b2e1d4..." \
  -H "Content-Type: application/json"

Görevler

Çalışma alanınızda AI aracı görevlerini oluşturun, listeleyin ve yönetin.

Çalışma alanındaki görevlerin, oluşturulma tarihine göre sıralanmış (önce en yenisi) sayfalandırılmış bir listesini döndürür.

ParametreTürAçıklama
limitintegerDöndürülecek maksimum sonuç (varsayılan: 50, maksimum: 200)
statusstringDuruma göre filtrele: beklemede, çalışıyor, tamamlandı, hata
offsetintegerSayfalandırma ofseti (varsayılan: 0)
// Yanıt 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 bir görev oluşturun ve bunu bir AI aracısına atayın.

AlanıTürGerekliAçıklama
titlestringEvetGörev başlığı (maks. 500 karakter)
descriptionstringEvetAyrıntılı görev açıklaması
agent_idintegerHayırAtanacak temsilcinin kimliği
priorityintegerHayırÖncelik düzeyi 1-10 (varsayılan: 5)
// İstek gövdesi
{
  "title": "Analyze Q2 sales data",
  "description": "Process the Q2 CSV and generate summary",
  "agent_id": 3,
  "priority": 8
}

Sonuç, hata mesajı ve ilişkili dosyalar da dahil olmak üzere belirli bir görevin tüm ayrıntılarını döndürür.

Temsilciler

Çalışma alanınızdaki AI aracılarını listeleyin ve yönetin.

Şu anda çalışma alanı ekibinizde bulunan tüm AI aracılarını döndürür.

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

Sohbet

Çalışma alanı sohbet mesajları oluşturun ve konuşma geçmişini alın.

AlanıTürGerekliAçıklama
messagestringEvetMesaj içeriği
agent_idintegerHayırDoğrudan mesaj için hedef aracı
ParametreTürAçıklama
limitintegerMaksimum mesaj (varsayılan: 50)
agent_idintegerBelirli temsilci DM'sine göre filtrele

Dosyalar

AI aracıları tarafından oluşturulan dosyalara erişin.

Çalışma alanınızda oluşturulan tüm dosyaları indirme belirteçleriyle birlikte döndürür.

Benzersiz indirme belirtecini kullanarak bir dosyayı indirin. Uygun MIME türüne sahip ikili dosyayı döndürür.

Çalışma Alanı

Çalışma alanı bilgilerini ve istatistiklerini alın.

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

Kullanım Takibi

Kimliği doğrulanmış her API isteği, Ayarlar'da gösterilen API anahtarının kullanım sayacını artırır. Görev oluşturma hâlâ çalışma alanı planının günlük görev sınırına uyuyor.

API Anahtarı
Kullanım
istek başına sayılır
Görevler
Planı
günlük görev sınırı geçerlidir
Dosyalar
Jeton
çalışma alanı anahtarı gerekli
İptal edilen API anahtarları hemen 401 yanıtını döndürür. Anahtarları burada oluşturun veya iptal edin: Ayarlar → API Anahtarları.

Hata Kodları

Standart HTTP hata kodları kullanılır. Hata yanıtları, ayrıntıları içeren bir JSON gövdesini içerir.

KoduDurumAçıklama
400Hatalı İstekGeçersiz istek gövdesi veya gerekli alanlar eksik
401YetkisizEksik veya geçersiz API anahtarı
403YasakAPI anahtarının bu kaynağa erişimi yok
404BulunamadıKaynak bulunamadı
500Sunucu HatasıDahili sunucu hatası — desteğe başvurun
// Hata yanıtı biçimi
{
  "error": "Unauthorized",
  "message": "Invalid or expired API key",
  "code": 401
}