Link to this sectionREST API Referansı#

Ultralytics Platform, veri setlerine, modellere, eğitime ve dağıtımlara programatik erişim için kapsamlı bir REST API sağlar.

# List your datasets
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/datasets

Link to this sectionAPI Genel Bakış#

API, temel platform kaynakları etrafında düzenlenmiştir:

graph LR
    A[API Key]:::start --> B[Datasets]:::proc
    A --> C[Projects]:::proc
    A --> D[Models]:::proc
    A --> E[Deployments]:::proc
    B -->|train on| D
    C -->|contains| D
    D -->|deploy to| E
    D -->|export| F[Exports]:::proc
    B -->|auto-annotate| B

    classDef start fill:#4CAF50,color:#fff
    classDef proc fill:#2196F3,color:#fff

Link to this sectionKimlik Doğrulama#

Kaynak API'leri, veri kümesi sınıfı ve bölme yönetimi, kopyalama, eğitim, dışa aktarma, dağıtımlar ve desteklenen hesap okumaları dahil olmak üzere API anahtarı kimlik doğrulaması kullanır. Halka açık uç noktalar, belirtilen durumlarda anonim erişimi destekler. Yalnızca tarayıcıya özel uygulama yolları hariç tutulmuştur.

Link to this sectionAPI Anahtarı Al#

1. Settings > API Keys yolunu izle
2. Create Key düğmesine tıkla
3. Oluşturulan anahtarı kopyala

Detaylı talimatlar için API Anahtarları bölümüne bak.

Link to this sectionYetkilendirme Başlığı#

API anahtarını tüm isteklerine dahil et:

Authorization: Bearer YOUR_API_KEY

Link to this sectionÖrnek#

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/datasets

Link to this sectionTemel URL#

Tüm API uç noktaları şunu kullanır:

https://platform.ultralytics.com/api

Link to this sectionHız Sınırları#

API, her API anahtarı için Upstash Redis destekli kayan pencere sınırları uygular. Her rota aşağıdaki eşleşen kategoriyi kullanır.

Hız sınırına ulaşıldığında, API 429 kodu ve yeniden deneme meta verileri döner:

Retry-After: 12
X-RateLimit-Reset: 2026-02-21T12:34:56.000Z

Link to this sectionAPI Anahtarı Başına Sınırlar#

Hız sınırları, çağrılan uç noktaya bağlı olarak otomatik uygulanır. Maliyetli işlemler, kötüye kullanımı önlemek için daha sıkı sınırlara sahiptir, standart CRUD işlemleri ise cömert bir varsayılan paylaşır:

Her kategorinin API anahtarı başına bağımsız bir sayacı vardır. Örneğin, 20 tahmin isteği yapmak, 100 istek/dk varsayılan hakkını etkilemez.

Link to this sectionÖzel Uç Noktalar (Sınırsız)#

Özel uç noktalar, uç nokta URL'sini doğrudan çağırdığında (örneğin https://predict-abc123.run.app/predict) Platform API anahtarı oran sınırlarına tabi değildir. Bu durumda aktarım hızı, dağıtılan servis yapılandırmasına bağlıdır.

Link to this sectionYanıt Formatı#

Link to this sectionBaşarılı Yanıtlar#

Yanıtlar, kaynağa özel alanlar içeren JSON döner:

{
    "datasets": [...],
    "total": 100
}

Link to this sectionHata Yanıtları#

{
    "error": "Dataset not found"
}

Link to this sectionVeri Kümeleri API'si#

YOLO modellerini eğitmek için etiketli görüntü veri kümeleri oluştur, göz at ve yönet. Veri Kümeleri belgelerine göz at.

Link to this sectionVeri Kümelerini Listele#

GET /api/datasets

Sorgu Parametreleri:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://platform.ultralytics.com/api/datasets?limit=10"

Yanıt:

{
    "datasets": [
        {
            "_id": "dataset_abc123",
            "name": "my-dataset",
            "slug": "my-dataset",
            "task": "detect",
            "imageCount": 1000,
            "classCount": 10,
            "classNames": ["person", "car"],
            "visibility": "private",
            "username": "johndoe",
            "starCount": 3,
            "isStarred": false,
            "sampleImages": [
                {
                    "url": "https://storage.example.com/...",
                    "width": 1920,
                    "height": 1080,
                    "labels": [{ "classId": 0, "bbox": [0.5, 0.4, 0.3, 0.6] }]
                }
            ],
            "createdAt": "2024-01-15T10:00:00Z",
            "updatedAt": "2024-01-16T08:30:00Z"
        }
    ],
    "total": 1,
    "region": "us"
}

Link to this sectionVeri Kümesini Getir#

GET /api/datasets/{datasetId}

Meta veriler, sınıf adları ve bölme sayıları dahil olmak üzere tüm veri kümesi ayrıntılarını döndürür.

Pass username when {datasetId} is a dataset slug rather than an ID.

Link to this sectionVeri Kümesi Oluştur#

POST /api/datasets

Gövde:

{
    "slug": "my-dataset",
    "name": "My Dataset",
    "task": "detect",
    "description": "A custom detection dataset",
    "visibility": "private",
    "classNames": ["person", "car"]
}

Yanıt:

{
    "datasetId": "dataset_abc123",
    "slug": "my-dataset",
    "region": "us"
}

Link to this sectionVeri Kümesini Güncelle#

PATCH /api/datasets/{datasetId}

Gövde (kısmi güncelleme):

{
    "name": "Updated Name",
    "description": "New description",
    "visibility": "public"
}

Link to this sectionVeri Kümesi Simgesi#

POST /api/datasets/{datasetId}/icon
DELETE /api/datasets/{datasetId}/icon

5 MB'a kadar bir WebP simgesini çok parçalı form alanı image olarak yükle veya mevcut simgeyi kaldır.

Link to this sectionVeri Kümesini Sil#

DELETE /api/datasets/{datasetId}

Veri kümesini yumuşak siler ( çöp kutusuna taşınır, 30 gün boyunca geri alınabilir).

Link to this sectionVeri Kümesini Kopyala#

POST /api/datasets/{datasetId}/clone

Tüm görseller ve etiketlerle birlikte halka açık, sahip olunan veya düzenlenebilir bir çalışma alanı veri kümesinin kopyasını oluşturur.

İsteğe bağlı gövde (tüm alanlar isteğe bağlıdır):

{
    "name": "cloned-dataset",
    "slug": "cloned-dataset",
    "description": "My cloned dataset",
    "visibility": "private",
    "license": "AGPL-3.0",
    "owner": "team-username"
}

Link to this sectionVeri Kümesini Dışa Aktar#

GET /api/datasets/{datasetId}/export

En son veri kümesi dışa aktarımı için imzalı bir indirme URL'si içeren bir JSON yanıtı döndürür.

Sorgu Parametreleri:

Yanıt:

{
    "downloadUrl": "https://storage.example.com/export.ndjson?signed=...",
    "cached": true
}

Link to this sectionVeri Kümesi Sürümü Oluştur#

POST /api/datasets/{datasetId}/export

Veri setinin numaralandırılmış yeni bir sürüm anlık görüntüsünü (snapshot) oluştur. Bu işlem, Editör erişimi veya daha yüksek bir yetki gerektirir. Sürüm; mevcut görüntü sayısını, sınıf sayısını, etiket sayısını ve bölünme (split) dağılımını yakalar, ardından değiştirilemez bir NDJSON dışa aktarması oluşturup saklar.

İstek Gövdesi:

{
    "description": "Added 500 training images"
}

Tüm alanlar isteğe bağlıdır. description alanı, kullanıcı tarafından sağlanan bir sürüm etiketidir.

Yanıt:

{
    "version": 3,
    "downloadUrl": "https://storage.example.com/v3.ndjson?signed=..."
}

Link to this sectionSürüm Açıklamasını Güncelle#

PATCH /api/datasets/{datasetId}/export

Mevcut bir sürümün açıklamasını güncelle. Bu, Editör erişimi veya daha yüksek bir yetki gerektirir.

İstek Gövdesi:

{
    "version": 2,
    "description": "Fixed mislabeled classes"
}

Yanıt:

{
    "ok": true
}

Link to this sectionVeri Kümesi Sürümünü Geri Yükle#

POST /api/datasets/{datasetId}/restore

Veri kümesinin görsellerini, açıklamalarını ve sınıflarını, görsel baytlarını kopyalamadan kaydedilmiş bir sürümden yeniden oluştur.

{
    "version": 2
}

Link to this sectionSınıf İstatistiklerini Getir#

GET /api/datasets/{datasetId}/class-stats

Sınıf dağılımını, konum ısı haritasını ve boyut istatistiklerini döndürür. Sonuçlar 5 dakikaya kadar önbelleğe alınır.

Yanıt:

{
    "classes": [{ "classId": 0, "count": 1500, "imageCount": 450 }],
    "imageStats": {
        "widthHistogram": [{ "bin": 640, "count": 120 }],
        "heightHistogram": [{ "bin": 480, "count": 95 }],
        "pointsHistogram": [{ "bin": 4, "count": 200 }]
    },
    "locationHeatmap": {
        "bins": [
            [5, 10],
            [8, 3]
        ],
        "maxCount": 50
    },
    "dimensionHeatmap": {
        "bins": [
            [2, 5],
            [3, 1]
        ],
        "maxCount": 12,
        "minWidth": 10,
        "maxWidth": 1920,
        "minHeight": 10,
        "maxHeight": 1080
    },
    "classNames": ["person", "car", "dog"],
    "cached": true,
    "sampled": false,
    "sampleSize": 1000
}

Link to this sectionSınıfları Yönet#

Sınıfları birleştir (ek açıklamaları kaynak sınıflardan hedef sınıfa yeniden ata, ardından kaynakları kaldır):

POST /api/datasets/{datasetId}/classes/merge

{
    "sourceClassIds": [2, 4],
    "targetClassId": 1
}

Sınıf kimlikleri konumsaldır, bu nedenle birleştirme işlemi idempotent değildir. Tekrar denemeden önce veri kümesini yeniden getir.

Sınıfları sil:

POST /api/datasets/{datasetId}/classes/delete

{
    "classIds": [2, 4]
}

Link to this sectionBölümleri Yeniden Dağıt#

POST /api/datasets/{datasetId}/splits/redistribute

Görselleri eğitim, doğrulama ve test bölmeleri arasında rastgele olarak yeniden ata. Yüzdelerin toplamı 100 olmalıdır.

{
    "train": 80,
    "val": 20,
    "test": 0
}

Link to this sectionVeri Kümesi Gömülüleri (Embeddings)#

GET /api/datasets/{datasetId}/embeddings
POST /api/datasets/{datasetId}/embeddings
DELETE /api/datasets/{datasetId}/embeddings

GET, mevcut UMAP analiz özetini ve aktif iş durumunu döndürür; POST bir gömülü analiz işini sıraya alır; DELETE aktif işi iptal eder.

Link to this sectionGörüntü Kümeleme#

GET /api/datasets/{datasetId}/images/clustering

Kümeleme dağılım görünümü için UMAP 2D düzenini ve görüntü başına meta verileri döndürür (sayfalandırılmış ve hız sınırlamalı).

Link to this sectionVeri Kümesinde Eğitilen Modelleri Getir#

GET /api/datasets/{datasetId}/models

Bu veri kümesi kullanılarak eğitilen modelleri döndürür.

Yanıt:

{
    "models": [
        {
            "_id": "model_abc123",
            "name": "experiment-1",
            "slug": "experiment-1",
            "status": "completed",
            "task": "detect",
            "epochs": 100,
            "bestEpoch": 87,
            "projectId": "project_xyz",
            "projectSlug": "my-project",
            "projectIconColor": "#3b82f6",
            "projectIconLetter": "M",
            "username": "johndoe",
            "startedAt": "2024-01-14T22:00:00Z",
            "completedAt": "2024-01-15T10:00:00Z",
            "createdAt": "2024-01-14T21:55:00Z",
            "metrics": {
                "mAP50": 0.85,
                "mAP50-95": 0.72,
                "precision": 0.88,
                "recall": 0.81
            }
        }
    ],
    "count": 1
}

Link to this sectionVeri Kümesini Otomatik Etiketle#

POST /api/datasets/{datasetId}/predict

Açıklamaları otomatik olarak oluşturmak için veri kümesi görüntülerinde YOLO çıkarımı çalıştır. Etiketlenmemiş görüntüler için etiketleri tahmin etmek üzere seçili bir model kullanır.

Gövde:

Link to this sectionVeri Kümesi Alımı#

POST /api/datasets/ingest

Mevcut bir veri kümesi için bir veri kümesi içe aktarma işi oluştur. Hedef veri kümesi, URL yolunda değil, her zaman JSON gövdesinde datasetId olarak iletilir.

İstek gövdesi, datasetId ve buna ek olarak sessionId (yüklenmiş bir arşivin yükleme oturumu) veya sourceUrl (uzak bir ZIP, TAR, TAR.GZ, TGZ veya NDJSON URL'si) seçeneklerinden tam olarak birini gerektirir. Arşivin ayrıştırma yapısını geçersiz kılmak için isteğe bağlı targetSplit (train, val veya test) parametresini ekle.

For uploaded archives, the upload session is already bound to the dataset by the assetId passed to POST /api/upload/signed-url; ingest validates that assetId matches the body datasetId. Optional classMapping entries map each incoming class name to an existing zero-based class index, a class name to reuse or create, or null to skip the class. For remote sourceUrl imports, create the dataset first, then pass its datasetId to ingest.

Gövde (yüklenen arşiv):

{
    "datasetId": "dataset_abc123",
    "sessionId": "session_abc123",
    "targetSplit": "train"
}

Gövde (uzak arşiv veya NDJSON):

{
    "datasetId": "dataset_abc123",
    "sourceUrl": "https://example.com/my-dataset.zip"
}

Gövde (daha sonraki veri girişi, etiketlerin içe aktarılması):

{
    "datasetId": "dataset_abc123",
    "sessionId": "session_abc123",
    "classMapping": { "person": 0, "automobile": "car", "background": null }
}

Yanıt:

{
    "jobId": "job_abc123",
    "datasetId": "dataset_abc123",
    "status": "queued"
}

graph LR
    A[POST /api/datasets]:::start --> B[POST /api/upload/signed-url]:::proc
    B --> C[Upload archive to signed URL]:::proc
    C --> D[POST /api/upload/complete]:::proc
    D --> E[POST /api/datasets/ingest]:::proc
    E --> F[Process archive]:::proc
    F --> G[Dataset ready]:::out

    classDef start fill:#4CAF50,color:#fff
    classDef proc fill:#2196F3,color:#fff
    classDef out fill:#9C27B0,color:#fff

Link to this sectionVeri Kümesi Görüntüleri#

Link to this sectionGörüntüleri Listele#

GET /api/datasets/{datasetId}/images

Sorgu Parametreleri:

Link to this sectionSeçili Görselleri Getir#

POST /api/datasets/{datasetId}/images

Sağlanan 1.000 görsel kimliğine kadar aynı görsel şeklini döndürür. Liste işlemiyle aynı URL ve etiket sorgu kontrollerini kabul eder.

{
    "imageIds": ["IMAGE_OBJECT_ID"]
}

Link to this sectionİmzalı Görüntü URL'lerini Getir#

POST /api/datasets/{datasetId}/images/urls

(Tarayıcıda görüntülemek için) bir dizi görüntü karması için imzalı URL'leri al.

Link to this sectionGörüntüyü Sil#

DELETE /api/datasets/{datasetId}/images/{hash}

Link to this sectionGörüntü Etiketlerini Getir#

GET /api/datasets/{datasetId}/images/{hash}/labels

Belirli bir görüntü için açıklamaları ve sınıf adlarını döndürür.

Link to this sectionGörüntü Etiketlerini Güncelle#

PUT /api/datasets/{datasetId}/images/{hash}/labels

Gövde:

{
    "labels": [
        { "classId": 0, "bbox": [0.5, 0.5, 0.2, 0.3] },
        { "classId": 1, "segments": [0.1, 0.2, 0.3, 0.2, 0.2, 0.4] }
    ]
}

Link to this sectionToplu Görüntü İşlemleri#

Görüntüleri bir veri kümesi içindeki bölmeler (train/val/test) arasında taşı:

PATCH /api/datasets/{datasetId}/images/bulk

Görüntüleri toplu sil:

DELETE /api/datasets/{datasetId}/images/bulk

Link to this sectionProjeler API'si#

Modellerini projeler halinde düzenle. Her model bir projeye aittir. Projeler belgelerine göz at.

Link to this sectionProjeleri Listele#

GET /api/projects

Sorgu Parametreleri:

Link to this sectionProjeyi Getir#

GET /api/projects/{projectId}

Link to this sectionProje Oluştur#

POST /api/projects

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-project",
    "slug": "my-project",
    "description": "Detection experiments"
  }' \
  https://platform.ultralytics.com/api/projects

Link to this sectionProjeyi Güncelle#

PATCH /api/projects/{projectId}

Link to this sectionProjeyi Sil#

DELETE /api/projects/{projectId}

Projeyi yumuşak siler ( çöp kutusuna taşınır).

Link to this sectionProjeyi Kopyala#

POST /api/projects/{projectId}/clone

Halka açık, sahip olunan veya düzenlenebilir bir çalışma alanı projesini ve modellerini hesabına veya çalışma alanına kopyalar. İsteğe bağlı JSON gövdesi name, slug, description, visibility, license ve hedef owner geçersiz kılmalarını kabul eder.

Link to this sectionProje Simgesi#

POST /api/projects/{projectId}/icon
DELETE /api/projects/{projectId}/icon

5 MB'a kadar bir WebP simgesini çok parçalı form alanı image olarak yükle veya mevcut simgeyi kaldır.

Link to this sectionModeller API'si#

Eğitilmiş YOLO modellerini yönet; metrikleri görüntüle, ağırlıkları indir, çıkarım çalıştır ve diğer formatlara aktar. Modeller dokümantasyonuna göz at.

Link to this sectionModelleri Listele#

GET /api/models

Sorgu Parametreleri:

Link to this sectionTamamlanan Modelleri Listele#

GET /api/models/completed

Eğitim ve dağıtım için tüm projelerde kullanılabilir ağırlıklara sahip 1.000 modele kadar geri döndürür. Bir çalışma alanı için owner bilgisini gönder.

Link to this sectionModeli Getir#

GET /api/models/{modelId}

Link to this sectionModel Oluştur#

POST /api/models

JSON Gövdesi:

Link to this sectionModeli Güncelle#

PATCH /api/models/{modelId}

Link to this sectionModeli Sil#

DELETE /api/models/{modelId}

Link to this sectionModel Dosyalarını İndir#

GET /api/models/{modelId}/files

Model dosyaları için imzalı indirme URL'leri döndürür.

Link to this sectionModeli Kopyala#

POST /api/models/{modelId}/clone

Halka açık, sahip olunan veya düzenlenebilir bir çalışma alanı modelini projelerinden birine kopyala.

Gövde:

{
    "targetProjectSlug": "my-project",
    "modelName": "cloned-model",
    "description": "Cloned from public model",
    "owner": "team-username"
}

Link to this sectionİndirmeyi İzle#

POST /api/models/{modelId}/track-download

Model indirme analizlerini izle.

Link to this sectionÇıkarımı Çalıştır.#

POST /api/models/{modelId}/predict

Halka açık modeller, kimlik doğrulaması olmadan tahmin edilebilir. Özel ve paylaşılan modeller, üst projeye erişimi olan bir API anahtarı gerektirir.

Çok Parçalı Form:

file veya source değerlerinden birini sağla. Maksimum yükleme boyutu 100 MB'dır.

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@image.jpg" \
  -F "conf=0.5" \
  https://platform.ultralytics.com/api/models/MODEL_ID/predict

Yanıt:

Yanıtlar; her görüntü için shape, speed, results ve isteğe bağlı yoğun piksel haritası verilerini (bir anlamsal sınıf haritası veya depth = pixel × max / divisor formülündeki bir derinlik haritası — varsayılan 8-bit harita için bölen 255, bits=12|16 ile 65535) ve ayrıca görüntü sayısı, işlev zamanlaması, görev ve hizmet sürümlerini içeren metadata bilgilerini barındırır. Dahili model yolları hiçbir zaman döndürülmez.

{
    "images": [
        {
            "shape": [1080, 1920],
            "results": [
                {
                    "class": 0,
                    "name": "person",
                    "confidence": 0.92,
                    "box": { "x1": 100, "y1": 50, "x2": 300, "y2": 400 }
                }
            ]
        }
    ],
    "metadata": {
        "imageCount": 1
    }
}

Link to this sectionEğitim API'si#

Bulut GPU'larında (RTX 2000 Ada'dan B300'e kadar 26 GPU tipi) YOLO eğitimini başlat ve ilerlemeyi gerçek zamanlı olarak izle. Bulut Eğitimi dokümantasyonuna bak.

graph LR
    A[POST /training/start]:::start --> B[Job Created]:::proc
    B --> C{Training}:::decide
    C -->|progress| D[GET /models/id/training]:::proc
    C -->|cancel| E[DELETE /models/id/training]:::error
    C -->|complete| F[Model Ready]:::out
    F --> G[Deploy or Export]:::proc

    classDef start fill:#4CAF50,color:#fff
    classDef proc fill:#2196F3,color:#fff
    classDef decide fill:#FF9800,color:#fff
    classDef out fill:#9C27B0,color:#fff
    classDef error fill:#F44336,color:#fff

Link to this sectionEğitimi Başlat#

POST /api/training/start

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "modelId": "MODEL_ID",
    "projectId": "PROJECT_ID",
    "gpuType": "rtx-4090",
    "trainArgs": {
      "model": "yolo26n.pt",
      "data": "ul://username/datasets/my-dataset",
      "epochs": 100,
      "imgsz": 640,
      "batch": 16
    }
  }' \
  https://platform.ultralytics.com/api/training/start

Link to this sectionGPU Uygunluğunu Getir#

GET /api/training/gpu-availability

GPU türü kimliğine göre mevcut GPU stok durumunu (High, Medium, Low veya null) döndürür. Herkese açıktır, kimlik doğrulaması gerektirmez; 5 dakika boyunca önbelleğe alınır.

Link to this sectionEğitim Durumunu Al#

GET /api/models/{modelId}/training

Mevcut eğitim işi durumunu, metrikleri, ilerlemeyi, zamanlamayı, GPU detaylarını ve hataları döndürür. Halka açık projeler kimlik doğrulaması olmadan erişilebilirdir; özel ve paylaşılan projeler, erişimi olan bir API anahtarı gerektirir.

Link to this sectionEğitimi İptal Et#

DELETE /api/models/{modelId}/training

Çalışan işlem örneğini sonlandırır ve işi iptal edildi olarak işaretler.

Link to this sectionDağıtım API'si#

Modelleri sağlık kontrolleri ve izleme ile özel çıkarım uç noktalarına dağıt. Yeni dağıtımlar varsayılan olarak sıfıra ölçeklemeyi kullanır ve API isteğe bağlı bir resources nesnesini kabul eder. Uç Noktalar dokümantasyonuna göz at.

graph LR
    A[Create]:::start --> B[Deploying]:::proc
    B --> C[Ready]:::out
    C -->|stop| D[Stopped]:::extern
    D -->|start| C
    C -->|delete| E[Deleted]:::error
    D -->|delete| E
    C -->|predict| F[Inference Results]:::out

    classDef start fill:#4CAF50,color:#fff
    classDef proc fill:#2196F3,color:#fff
    classDef out fill:#9C27B0,color:#fff
    classDef error fill:#F44336,color:#fff
    classDef extern fill:#607D8B,color:#fff

Link to this sectionDağıtımları Listele#

GET /api/deployments

Sorgu Parametreleri:

Link to this sectionDağıtım Oluştur#

POST /api/deployments

Gövde:

{
    "modelId": "model_abc123",
    "name": "my-deployment",
    "region": "us-central1",
    "resources": {
        "cpu": 1,
        "memoryGi": 2,
        "minInstances": 0,
        "maxInstances": 1
    }
}

Belirtilen bölgede özel bir çıkarım uç noktası oluşturur. Uç nokta benzersiz bir URL aracılığıyla küresel olarak erişilebilirdir.

Link to this sectionDağıtımı Getir#

GET /api/deployments/{deploymentId}

Link to this sectionDağıtımı Sil#

DELETE /api/deployments/{deploymentId}

Link to this sectionDağıtımı Başlat#

POST /api/deployments/{deploymentId}/start

Durdurulmuş bir dağıtımı devam ettir.

Link to this sectionDağıtımı Durdur#

POST /api/deployments/{deploymentId}/stop

Servisin minimum ve maksimum örnek sayısını sıfıra ayarlayarak istek sunmayı durdur.

Link to this sectionSağlık Kontrolü#

GET /api/deployments/{deploymentId}/health

Dağıtım uç noktasının sağlık durumunu döndürür.

Link to this sectionDağıtımda Çıkarım Çalıştır#

POST /api/deployments/{deploymentId}/predict

Çıkarım için bir görüntüyü doğrudan dağıtım uç noktasına gönder. İşlevsel olarak model tahminiyle eşdeğerdir ancak daha düşük gecikme için özel uç nokta üzerinden yönlendirilir.

Çok Parçalı Form:

file veya source değerlerinden birini sağla. Yanıt, model tahminiyle aynı görsel ve meta veri sözleşmesini kullanır ve dahili model yolunu asla döndürmez.

Link to this sectionMetrikleri Getir#

GET /api/deployments/{deploymentId}/metrics

İstek sayılarını, gecikmeyi ve hata oranı metriklerini kıvılcım grafiği verileriyle döndürür.

Sorgu Parametreleri:

Link to this sectionGünlükleri Getir#

GET /api/deployments/{deploymentId}/logs

Sorgu Parametreleri:

Link to this sectionDışa Aktarma (Export) API#

Modelleri uçta dağıtım için ONNX, TensorRT, CoreML ve LiteRT gibi optimize edilmiş biçimlere dönüştür. Dağıtım belgelerine göz at.

Link to this sectionDışa Aktarımları Listele#

GET /api/exports

Sorgu Parametreleri:

Link to this sectionDışa Aktarma Oluştur#

POST /api/exports

Gövde:

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"modelId": "MODEL_ID", "format": "onnx"}' \
  https://platform.ultralytics.com/api/exports

Desteklenen Formatlar:

Aşağıdaki paylaşılan dışa aktarma tablosundaki format argümanını kullan. PyTorch kaynak formatıdır ve bir API dışa aktarma hedefi değildir.

Link to this sectionDışa Aktarma Durumunu Al#

GET /api/exports/{exportId}

Link to this sectionDışa Aktarmayı İptal Et#

DELETE /api/exports/{exportId}

Link to this sectionDışa Aktarma İndirmesini İzle#

POST /api/exports/{exportId}/track-download

Link to this sectionEtkinlik (Activity) API#

Hesabındaki son eylemlerin akışını görüntüle — eğitim çalıştırmaları, yüklemeler ve daha fazlası. Etkinlik belgelerine bak.

Link to this sectionEtkinlikleri Listele#

GET /api/activity

Sorgu Parametreleri:

Link to this sectionEtkinlikleri Görüldü Olarak İşaretle#

POST /api/activity/mark-seen

Gövde:

{
    "all": true
}

Veya belirli kimlikleri ilet:

{
    "eventIds": ["EVENT_ID_1", "EVENT_ID_2"]
}

Bir çalışma alanındaki etkinlikleri işaretlemek için isteğe bağlı owner sorgu parametresini gönder.

Link to this sectionEtkinlikleri Arşivle#

POST /api/activity/archive

Gövde:

{
    "all": true,
    "archive": true
}

Veya belirli kimlikleri ilet:

{
    "eventIds": ["EVENT_ID_1", "EVENT_ID_2"],
    "archive": false
}

Çalışma alanı etkinliklerini arşivlemek veya geri yüklemek için isteğe bağlı owner sorgu parametresini gönder.

Link to this sectionÇöp Kutusu (Trash) API#

Silinen öğeleri görüntüle ve geri yükle. Öğeler 30 gün sonra kalıcı olarak silinir. Çöp Kutusu belgelerine bak.

Link to this sectionÇöp Kutusunu Listele#

GET /api/trash

Sorgu Parametreleri:

Link to this sectionÖğeyi Geri Yükle#

POST /api/trash

Gövde:

{
    "id": "item_abc123",
    "type": "dataset"
}

Link to this sectionÖğeyi Kalıcı Olarak Sil#

DELETE /api/trash

Gövde:

{
    "id": "item_abc123",
    "type": "dataset"
}

Link to this sectionÇöp Kutusunu Boşalt#

DELETE /api/trash/empty

Çöp kutusundaki tüm öğeleri kalıcı olarak siler.

Link to this sectionFaturalandırma API#

Kredi bakiyeni, plan kullanımını ve işlem geçmişini kontrol et. Faturalandırma belgelerine göz at.

Bakiye ve işlem uç noktaları, çalışma alanı sahibinin kullanıcı adını içeren isteğe bağlı bir owner sorgu parametresi kabul eder.

Link to this sectionBakiyeyi Al#

GET /api/billing/balance

Yanıt:

{
    "creditsCents": 2500,
    "plan": "free"
}

Link to this sectionKullanım Özetini Al#

GET /api/billing/usage-summary

Plan detaylarını, limitleri ve kullanım metriklerini döndürür.

Link to this sectionİşlemleri Al#

GET /api/billing/transactions

İşlem geçmişini döndürür (en son işlem önce gelecek şekilde).

İşlemler, tutar, sonuç bakiyesi, tarih, isteğe bağlı model bağlamı ve makbuz URL'si gibi müşteri tarafındaki defter alanlarını içerir. Dahili notlar, Stripe ödeme/iade kimlikleri ve idempotent anahtarlar döndürülmez.

Link to this sectionDepolama API'si#

Depolama kullanım dökümünü kategoriye (veri kümeleri, modeller, dışa aktarmalar) göre kontrol et ve en büyük öğelerini görüntüle.

Link to this sectionDepolama Bilgisini Al#

GET /api/storage

Sorgu Parametreleri:

Yanıt:

{
    "tier": "free",
    "usage": {
        "storage": {
            "current": 1073741824,
            "limit": 107374182400,
            "percent": 1.0
        }
    },
    "region": "us",
    "username": "johndoe",
    "updatedAt": "2024-01-15T10:00:00Z",
    "breakdown": {
        "byCategory": {
            "datasets": { "bytes": 536870912, "count": 2 },
            "models": { "bytes": 268435456, "count": 4 },
            "exports": { "bytes": 268435456, "count": 3 }
        },
        "topItems": [
            {
                "_id": "dataset_abc123",
                "name": "my-dataset",
                "slug": "my-dataset",
                "sizeBytes": 536870912,
                "type": "dataset"
            },
            {
                "_id": "model_def456",
                "name": "experiment-1",
                "slug": "experiment-1",
                "sizeBytes": 134217728,
                "type": "model",
                "parentName": "My Project",
                "parentSlug": "my-project"
            }
        ]
    }
}

Link to this sectionBulut Depolama Entegrasyonları#

Salt okunur GCS, S3 veya Azure Blob depolama entegrasyonlarına bağlan ve bunlara göz at:

GET /api/integrations/buckets
POST /api/integrations/buckets
POST /api/integrations/buckets/discover
GET /api/integrations/buckets/{id}/objects

Dört işlemin tamamı, bir çalışma alanı için isteğe bağlı owner sorgu parametresini kabul eder. Nesne tarama ayrıca gerekli target ile isteğe bağlı prefix ve sağlayıcı cursor sorgu parametrelerini kabul eder. Bağlantı ve keşif istek gövdeleri, etkileşimli OpenAPI referansındaki sağlayıcı kimlik bilgisi şemalarını kullanır; kimlik bilgileri asla döndürülmez.

Link to this sectionYükleme API'si#

Hızlı ve güvenilir aktarımlar için imzalı URL'ler kullanarak dosyaları doğrudan bulut depolamaya yükle. Model yüklemesini tamamlamak ağırlıklarını ekler. Veri kümesi arşivi yüklemesini tamamlamak oturumu kaydeder; işlemeye başlamak için bu sessionId değerini POST /api/datasets/ingest adresine gönder. Veri belgelerine bak.

Link to this sectionİmzalı Yükleme URL'sini Al#

POST /api/upload/signed-url

Doğrudan bulut depolamaya dosya yüklemek için imzalı bir URL talep et. İmzalı URL, büyük dosya transferleri için API sunucusunu atlar.

Gövde:

{
    "assetType": "datasets",
    "assetId": "dataset_abc123",
    "filename": "my-dataset.zip",
    "contentType": "application/zip",
    "totalBytes": 52428800
}

Yanıt:

{
    "sessionId": "session_abc123",
    "uploadUrl": "https://storage.example.com/...",
    "expiresAt": "2026-02-22T12:00:00Z"
}

Link to this sectionYüklemeyi Tamamla#

POST /api/upload/complete

Platforma bir dosya yüklemesinin tamamlandığını bildir. Modeller için bu, yüklenen ağırlıkları ekler. Veri kümesi arşivleri için bu, yükleme oturumunu doğrular ve kaydeder; veri kümesi işlemeye başlamak için sonrasında POST /api/datasets/ingest çağrısı yap.

Gövde:

{
    "sessionId": "session_abc123",
    "checksum": "<optional sha-256 hex>"
}

Link to this sectionEntegrasyonlar API#

Veri kümelerini üçüncü taraf hizmetlerden içe aktar. Entegrasyonlar belgelerine göz at.

Link to this sectionRoboflow İçe Aktarmayı Önizle#

POST /api/integrations/roboflow/preview

Bir Roboflow API key değerini toplu içe aktarma planına çözümle: çalışma alanı bilgisi, yeni içe aktarılacak projeler, zaten içe aktarılmış versiyon sayısı (atlandı) ve desteklenmeyen proje türleri. Roboflow API key gövdede iletilir ve kalıcı olarak saklanmaz.

Link to this sectionRoboflow'dan İçe Aktar#

POST /api/integrations/roboflow/import

Seçilen Roboflow projelerini çalışma alanına içe aktarmak için veri kümesi alım işlerini sıraya al. Depolama alanı boşluğu gerektirir ve her veri kümesi planının içe aktarma başına boyut sınırına uygun olmalıdır.

Link to this sectionAPI Anahtarları API'si#

Programatik erişim için API anahtarlarını yönet. API Anahtarları belgelerine bak.

Link to this sectionAPI Anahtarlarını Listele#

GET /api/api-keys

API anahtarı kimlik doğrulamalı istemciler anahtar meta verilerini alır, mevcut anahtar değerlerinin şifresi asla çözülmez. Yeni oluşturulan bir anahtar, POST /api/api-keys tarafından bir kez döndürülür.

Düzenleyici erişimine sahip olduğun bir çalışma alanı için anahtarları yönetmek üzere isteğe bağlı owner sorgu parametresini gönder.

Link to this sectionAPI Anahtarı Oluştur#

POST /api/api-keys

Gövde:

{
    "name": "training-server"
}

Link to this sectionAPI Anahtarını Sil#

DELETE /api/api-keys

Sorgu Parametreleri:

Örnek:

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://platform.ultralytics.com/api/api-keys?keyId=KEY_ID"

Link to this sectionTakımlar ve Üyeler API'si#

İş birliği için takım çalışma alanları oluştur, üyeleri davet et ve rolleri yönet. Takımlar belgelerine bak.

Link to this sectionTakımları Listele#

GET /api/teams

Link to this sectionTakım Oluştur#

POST /api/teams/create

Gövde:

{
    "username": "my-team",
    "fullName": "My Team"
}

Link to this sectionÜyeleri Listele#

GET /api/members

Mevcut çalışma alanındaki üyeleri döndürür.

Link to this sectionÜye Davet Et#

POST /api/members

Gövde:

{
    "email": "user@example.com",
    "role": "editor"
}

Link to this sectionÜye Rolünü Güncelle#

PATCH /api/members/{userId}

Link to this sectionÜyeyi Kaldır#

DELETE /api/members/{userId}

Link to this sectionSahipliği Devret#

POST /api/members/transfer-ownership

Link to this sectionKeşfet (Explore) API'si#

Topluluk tarafından paylaşılan herkese açık veri kümelerini ve projeleri ara ve göz at. Keşfet belgelerine bak.

Link to this sectionHerkese Açık İçeriği Ara#

GET /api/explore/search

Sorgu Parametreleri:

Link to this sectionKenar Çubuğu Verileri#

GET /api/explore/sidebar

Keşfet kenar çubuğu için küratörlü içeriği döndürür.

Link to this sectionKullanıcı ve Ayarlar API'leri#

Profilini, API anahtarlarını, depolama kullanımını ve ekip çalışma alanlarını yönet. Ayarlar belgelerine bak.

Link to this sectionHesap Özeti#

GET /api/account/summary

Kimliği doğrulanmış hesabın planını, kredi bakiyesini, kaynak sayılarını ve ekip çalışma alanlarını döndürür.

Link to this sectionKullanıcı Adına Göre Kullanıcıyı Al#

GET /api/users

Sorgu Parametreleri:

Link to this sectionKullanıcıyı Takip Et veya Takibi Bırak#

PATCH /api/users

Gövde:

{
    "username": "target-user",
    "followed": true
}

Link to this sectionKullanıcı Adı Kullanılabilirliğini Kontrol Et#

GET /api/username/check

Sorgu Parametreleri:

Link to this sectionAyarlar#

GET /api/settings
POST /api/settings

Kullanıcı profili ayarlarını (görünen ad, biyografi, sosyal medya bağlantıları vb.) al veya güncelle.

Link to this sectionÇalışma Alanı Simgesi#

POST /api/settings/icon
DELETE /api/settings/icon

5 MB'a kadar bir WebP profil/çalışma alanı simgesini çok parçalı form alanı image olarak yükle veya kaldır. Bir ekip çalışma alanı için isteğe bağlı owner bilgisini gönder.

Link to this sectionPython Entegrasyonu#

Daha kolay entegrasyon için, kimlik doğrulama, yüklemeler ve gerçek zamanlı metrik akışını otomatik olarak yöneten Ultralytics Python paketini kullan.

Link to this sectionKurulum & Ayarlar#

pip install "ultralytics>=8.4.104"

Kurulumu doğrula:

yolo check

Link to this sectionKimlik Doğrulama#

yolo settings api_key=YOUR_API_KEY

Link to this sectionPlatform Veri Kümelerini Kullanma#

Veri kümelerine ul:// URI'leri ile referans ver:

from ultralytics import YOLO

model = YOLO("yolo26n.pt")

# Train on your Platform dataset
model.train(
    data="ul://your-username/datasets/your-dataset",
    epochs=100,
    imgsz=640,
)

URI Formatı:

Link to this sectionPlatforma Gönderme#

Sonuçları bir Platform projesine gönder:

from ultralytics import YOLO

model = YOLO("yolo26n.pt")

# Results automatically sync to Platform
model.train(
    data="coco8.yaml",
    epochs=100,
    project="your-username/my-project",
    name="experiment-1",
)

Senkronize edilenler:

• Eğitim metrikleri (gerçek zamanlı)
• Nihai model ağırlıkları
• Doğrulama grafikleri
• Konsol çıktısı
• Sistem metrikleri

Link to this sectionAPI Örnekleri#

Platformdan bir model yükle:

# Your own model
model = YOLO("ul://username/project/model-name")

# Official model
model = YOLO("ul://ultralytics/yolo26/yolo26n")

Çıkarım çalıştır:

results = model("image.jpg")

# Access results
for r in results:
    boxes = r.boxes  # Detection boxes
    masks = r.masks  # Segmentation masks
    keypoints = r.keypoints  # Pose keypoints
    probs = r.probs  # Classification probabilities

Modeli dışa aktar:

# Export to ONNX
model.export(format="onnx", imgsz=640, quantize=16)

# Export to TensorRT
model.export(format="engine", imgsz=640, quantize=16)

# Export to CoreML
model.export(format="coreml", imgsz=640)  # use imgsz=224 for classification

Doğrulama:

metrics = model.val(data="ul://username/datasets/my-dataset")

print(f"mAP50: {metrics.box.map50}")
print(f"mAP50-95: {metrics.box.map}")

Link to this sectionSSS#

Link to this sectionBüyük sonuçları nasıl sayfalandırırım?#

Çoğu uç nokta, istek başına kaç sonucun döndürüleceğini kontrol etmek için bir limit parametresi kullanır:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://platform.ultralytics.com/api/datasets?limit=50"

Etkinlik ve Çöp Kutusu uç noktaları, sayfa tabanlı sayfalandırma için bir page parametresini de destekler:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://platform.ultralytics.com/api/activity?page=2&limit=20"

The Explore Search endpoint uses offset instead of page, with a fixed page size of 20:

curl "https://platform.ultralytics.com/api/explore/search?type=datasets&offset=20&sort=stars"

Link to this sectionAPI'yi SDK olmadan kullanabilir miyim?#

Yukarıda belgelenen halka açık REST işlemleri, Python SDK olmadan kullanılabilir. SDK, gerçek zamanlı metrik akışı ve otomatik model yüklemeleri gibi özellikler ekleyen kolay bir sarmalayıcıdır. Makine tarafından okunabilir sözleşmeyi platform.ultralytics.com/api/docs adresinde etkileşimli olarak inceleyebilirsin; yalnızca tarayıcı oturumuna özel hesap akışları Platform UI içinde kalmaya devam eder.

Link to this sectionAPI istemci kütüphaneleri var mı?#

Ultralytics Python paketini kullan veya herhangi bir dilden doğrudan HTTP istekleri yap.

Link to this sectionHız sınırlarını (rate limits) nasıl yönetirim?#

Doğru miktarda zaman beklemek için 429 yanıtındaki Retry-After başlığını kullan:

import time

import requests

def api_request_with_retry(url, headers, max_retries=3):
    for attempt in range(max_retries):
        response = requests.get(url, headers=headers)
        if response.status_code != 429:
            return response
        wait = int(response.headers.get("Retry-After", 2**attempt))
        time.sleep(wait)
    raise RuntimeError("Rate limit exceeded")

Link to this sectionModel veya veri kümesi kimliğimi (ID) nasıl bulurum?#

Kaynak kimlikleri (IDs) oluşturma, listeleme ve alma API yanıtları tarafından döndürülür. Platform sayfa URL'leri veritabanı kimlikleri yerine insan tarafından okunabilir kısa adlar (slugs) kullanır:

https://platform.ultralytics.com/username/project/model-name
                                  ^^^^^^^^ ^^^^^^^ ^^^^^^^^^^
                                  username project   model

Bir model, veri seti, proje, dağıtım veya diğer kaynaklar için ilgili _id değerini bulmak üzere liste uç noktalarını kullan.