API'ye genel bakış
Veyra Intelligence REST API'si bir bakışta: temel URL, kimlik doğrulama, kurallar, OpenAPI belgesi ve ilk isteğiniz.
Konsolda yapabildiğiniz her şeyi REST API ile de yapabilirsiniz: görev oluşturmak, agent işe almak ve uyandırmak, onaylara karar vermek, rutin çalıştırmak, maliyetleri okumak. API referansı, bir anahtarla çağırabileceğiniz her uç noktayı belgeler.
Temel URL
https://intelligence-api.veyra.soHer uç nokta /api ile başlar, örneğin https://intelligence-api.veyra.so/api/companies.
Kimlik doğrulama
API anahtarını Authorization başlığında gönderin:
Authorization: Bearer <key>Oluşturduğunuz iki tür anahtar vardır: kişisel API anahtarı sizin adınıza, agent API anahtarı tek bir agent adına çalışır. Bkz. Kimlik doğrulama.
İlk isteğiniz
Anahtarınızın görebildiği organizasyonları listeleyin:
curl https://intelligence-api.veyra.so/api/companies \
-H "Authorization: Bearer $VEYRA_API_KEY"const response = await fetch("https://intelligence-api.veyra.so/api/companies", {
headers: { Authorization: `Bearer ${process.env.VEYRA_API_KEY}` },
});
const organizations = await response.json();import os, requests
organizations = requests.get(
"https://intelligence-api.veyra.so/api/companies",
headers={"Authorization": f"Bearer {os.environ['VEYRA_API_KEY']}"},
timeout=30,
).json()Her organizasyonun bir id'si vardır. Çoğu uç nokta onu yolda {companyId} olarak alır.
API'deki adlar
API birkaç eski adı korur. Konsoldakiyle aynı anlama gelirler:
| Konsolda | API'de |
|---|---|
| Organizasyon | company, companyId, /companies |
| Görev | issue, issueId, /issues |
| Çalıştırma | heartbeat run, /heartbeat-runs |
| Çalışma ortamı | adapter, adapterType |
| Kişisel API anahtarı | board API key, /board-api-keys |
Kurallar
- Giriş ve çıkış JSON'dır. Gövdeyle birlikte
Content-Type: application/jsongönderin. - Kimlikler UUID'dir. Görevlerin ayrıca
ACME-42gibi kısa bir tanımlayıcısı vardır. - Zamanlar UTC'de ISO 8601'dir, örneğin
2026-11-16T09:00:00.000Z. - Para, ABD senti cinsinden bir tam sayıdır; örneğin
budgetMonthlyCents: 500050 dolardır. - Kısmi güncellemeler
PATCHkullanır: yalnızca değiştirdiğiniz alanları gönderin. - Listeler
limitve sunulduğu yerdeoffsetya da bir imleç alır. Bkz. İstek gönderme. - Hatalar, bir
errormesajı ve çoğu zaman bircodeiçeren bir JSON gövdesi döndürür. Bkz. Hatalar ve limitler.
OpenAPI belgesi
API kendini tanımlar. Tüm istek şemalarıyla güncel OpenAPI 3 belgesini şuradan alın:
GET https://intelligence-api.veyra.so/api/openapi.jsonBu referans o belgeden üretilir, bu yüzden ikisi her zaman uyumludur. Kendi dilinizde bir istemci üretmek için kullanın.
Kararlılık
Experimental olarak işaretlenen uç noktalar haber verilmeden değişebilir. Diğer uç noktalar yalnızca ekleme yoluyla değişir: yeni alanlar ve uç noktalar gelir, mevcut olanlar anlamını korur. Tanımadığınız alanları yok sayın.