geti-using-the-pipeline
Use the Geti application end to end through its REST API — the project → dataset → annotate → train → deploy pipeline served by the FastAPI backend in `application/backend/`. Use when a user (not a contributor) wants to create a project, upload media, add annotations, launch a training or quantization job, track job status, configure a source → model → sink inference pipeline, and enable live inference. Covers the `/api/...` endpoints and the async job model, not backend code changes.
How do I install this agent skill?
npx skills add https://github.com/open-edge-platform/geti --skill geti-using-the-pipelineIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides instructional guidance for using the Geti application's REST API to manage computer vision workflows, including project creation, annotation, and model training. No security risks were identified.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
Using the Geti pipeline (application)
The Geti application is a FastAPI server (application/backend/, the geti
package) that exposes a REST API for the full computer-vision workflow: create a
project, upload and annotate media, train a model as an async job,
then configure and enable a live inference pipeline (source → model →
sink). This skill is about using that API; to change backend code use the
geti-backend-dev skill instead.
Start the server from application/backend/ with just run-server (default
https://localhost:7860). The full endpoint reference is
application/docs/api.md; interactive docs are the generated OpenAPI spec.
End-to-end pipeline
flowchart LR
A[Create project] --> B[Upload media]
B --> C[Annotate media]
C --> D[Train job]
D --> E[Configure pipeline: source, model, sink]
E --> F[Enable pipeline / live inference]
- Create a project with a task type and labels.
POST /api/projects(name, task, labels) → project info.- Done when:
GET /api/projects/<id>returns the project with its labels.
- Upload media (images/videos) to the project dataset.
POST /api/projects/<id>/dataset/media(binary) → media info.- Done when:
GET /api/projects/<id>/dataset/medialists the uploaded item.
- Annotate media so the dataset is trainable.
POST /api/projects/<id>/dataset/media/<media_id>/annotations(annotation info).- Done when:
GET .../annotationsreturns the saved annotation. - (Optional) import an existing dataset instead via the dataset jobs below.
- Train a model as an async job.
POST /api/jobswith job typetrain→ job id.- Track it:
GET /api/jobs/<id>, streamGET /api/jobs/<id>/statusandGET /api/jobs/<id>/logs; cancel withPOST /api/jobs/<id>:cancel. - Done when: the job reaches a finished state and
GET /api/projects/<id>/modelslists the new model.
- (Optional) Quantize the trained model for faster inference.
POST /api/jobswith job typequantize.- Done when: the quantized model variant appears under the project's models.
- Configure the inference pipeline — bind a source, the model, and a sink.
- Sources:
POST /api/sources; sinks:POST /api/sinks. PATCH /api/projects/<id>/pipelinewith the ids of source, sink, and model.- Done when:
GET /api/projects/<id>/pipelineshows the wired components.
- Sources:
- Enable live inference and monitor it.
POST /api/projects/<id>/pipeline:enable(disable with:disable).- Metrics:
GET /api/projects/<id>/pipeline/metrics(latency, throughput). POST /api/projects/<id>/pipeline:capturecollects the next frame into the dataset for continued annotation/retraining.- Done when: the pipeline reports active and metrics update.
The async job model
Long-running work runs as jobs (POST /api/jobs), keeping the API
responsive. Job types: train, quantize, prepare_dataset_for_import,
import_dataset_to_existing_project, import_dataset_as_new_project,
export_dataset, stage_dataset. Poll GET /api/jobs/<id> or stream
/status and /logs; jobs are cancelable.
Datasets: import instead of manual annotation
To bring in an existing dataset rather than annotating from scratch:
- Upload an archive to staging:
POST /api/staged_datasets. - Then submit an import job (
import_dataset_as_new_projectorimport_dataset_to_existing_project) viaPOST /api/jobs. - Export a project's dataset with the
export_datasetjob.
Notes
- Training and quantization jobs run out-of-process and call into the
getitunelibrary; the underlying capabilities map to thegetitune-training-a-modelandgetitune-optimizing-a-modelskills. - This skill covers API usage; endpoint paths and payloads are the contract in
application/docs/api.md. To add or change endpoints, usegeti-backend-devandgeti-openapi-sync.
Related skills
getitune-training-a-model/getitune-optimizing-a-model— the library capabilities behind thetrainandquantizejobs.geti-backend-dev— change the backend/API itself.geti-ui-dev— the web UI that drives this same API.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/open-edge-platform/geti/geti-using-the-pipeline">View geti-using-the-pipeline on skillZs</a>