Referans
API referansı
Barındırılan OpenAPI referansının nerede olduğu, nasıl kimlik doğrulanacağı, her yanıtın neye benzediği ve hız sınırları.
Polylane API referansının tamamı platformun sunduğu OpenAPI belirtiminden üretilir, bu yüzden her zaman dağıtılanla eşleşir.
Kimlik doğrulama
x-api-key başlığında bir çalışma alanı API anahtarı ya da Authorization: Bearer içinde bir OAuth erişim tokenı gönder. İkisini de konsolda oluştur; bkz. API anahtarları ve OAuth istemcileri.
Terminal
curl https://api.polylane.com/v1/workspaces \
-H "x-api-key: $POLYLANE_API_KEY"
Yanıt biçimi
Her JSON yanıtı aynı zarfı kullanır.
| Alan | Açıklama |
|---|---|
success | İstek başarılı olduğunda true, başarısız olduğunda false. |
message | Başarıda, message alanı durumu açıklayan bir nesne. Başarısızlıkta null. |
error | Başarıda null. Başarısızlıkta bir message, isteğe bağlı bir detail ve isteğe bağlı metadata içeren bir nesne. |
result | Başarıda yük. Başarısızlıkta yok. |
{
"success": true,
"message": { "message": "Successful request" },
"error": null,
"result": { "items": [], "count": 0 }
}
Hız sınırları
| Yüzey | Sınır |
|---|---|
| REST API | Kimlik bilgisi başına 60 saniyede 5,000 istek |
| Platform MCP sunucusu | Kimlik bilgisi başına 60 saniyede 600 istek |
Yanıtlar politikayı RateLimit-Limit ve RateLimit-Policy başlıklarında bildirir. Sınırın üzerinde API, pencereyi saniye olarak taşıyan bir Retry-After başlığıyla 429 yanıtlar; süre dolana kadar geri çekil, sonra yeniden dene.
Her işlem aynı belirtimden üretilen CLI üzerinden de çağrılabilir.
İlgili
- Bu isteklerin kullandığı kimlik bilgilerini oluşturmak için API anahtarları ve OAuth istemcileri.
- API'yi bir terminalden veya bir betikten çağırmak için CLI.
- Aynı veriye bir editör ajanından ulaşmak için Platform MCP sunucusu.