Sign in Get started

API reference

Every SDK resource, one page each. Each method maps 1:1 to a REST endpoint.

View as Markdown

The Pictograph SDK exposes 15 resource groups under client.<resource>. Each method maps 1:1 to a REST endpoint. Use the SDK for type safety and auto-retry; use raw REST when you need a non-Python language.

from pictograph import Client
client = Client()

Resources

ResourcePurpose
DatasetsProject CRUD and bulk download
ImagesSingle-image upload / download / delete
AnnotationsPer-image annotation read / save / delete
Auto-annotateSAM3 point / box / text / batch prompts
SearchTag and similarity search across a dataset
BatchBulk move / copy / delete / update on images
ExportsDataset exports in COCO, YOLO, CVAT, Pascal VOC, LabelMe, CSV
TrainingSpawn and monitor training runs
ModelsList and download trained ONNX weights
CreditsBalance, ledger, pre-flight cost estimation
ConnectorsV7 / Roboflow dataset import
VideoVideo upload + frame extraction
OrganizationsMembers and invites for the active org
ProjectsProject config (classes, annotation types)
API keysProgrammatic key management
ToolsAgent tool registry (JSON Schema reference)

Prefer workflows for end-to-end tasks

For multi-step flows like “upload, annotate, train”, reach for pictograph.workflows before chaining resource calls. Workflows handle short-circuit on failure, credit gating, and report aggregation for you.

WorkflowChains
full_pipelineupload → auto-annotate → train
upload_dataset_from_folderwalk folder → bulk upload
auto_annotate_datasetlist images → batch SAM3 → save
train_pipelineexport → train → fetch model

Each workflow is also exposed as an agent tool.

Conventions across resources

  • Name-based lookups are preferred (get(name=...)). UUID variants exist where useful (get_by_id(...)).
  • Pagination: .list() returns one page; .iter() returns an OffsetPager that auto-fetches subsequent pages.
  • Long-running ops (training, exports, batch SAM3, dataset imports) default to wait=True and poll until terminal. Pass wait=False to fire-and-forget.
  • Failure reports: bulk operations return per-item failure lists rather than raising on the first error.
  • Idempotency: mutating operations auto-generate Idempotency-Key headers — safe to retry. Pass idempotency_key= to set it explicitly.
Copied to clipboard