{"reference_analysis":{"checked_at":"2026-10-08","provider":"CVAT","about_url":"https://docs.cvat.ai/docs/getting_started/overview/","source_access":{"en":"Official project and SDK documentation read on 2026-10-08; pages showed the develop documentation track. Company About retrieval failed, so this page uses the official project overview. Verify against your installed release.","zh-TW":"於 2026-10-08 讀取官方專案及 SDK 文件，頁面顯示 develop 文件分支。公司 About 擷取失敗，因此採用官方專案概覽；實作需對照已安裝版本。"},"selection_basis":{"en":"Ten documented interfaces, operations or tools selected by integration task; not an official ranking or ten separate SDKs.","zh-TW":"依整合任務挑選十個文件記載的介面、操作或工具；不是官方排名或十個獨立 SDK。"},"about":[{"label":{"en":"Project purpose","zh-TW":"專案定位"},"value":{"en":"CVAT provides annotation and dataset workflows for visual and audio data.","zh-TW":"CVAT 提供視覺及音訊資料的標註與資料集工作流程。"}},{"label":{"en":"Scope","zh-TW":"範圍"},"value":{"en":"Official documentation covers images, video, audio, 3D, QA and team collaboration.","zh-TW":"官方文件涵蓋影像、視訊、音訊、3D、QA 與團隊協作。"}},{"label":{"en":"Deployment choices","zh-TW":"部署選擇"},"value":{"en":"Online, Community and Enterprise offerings are documented; verify the chosen edition’s features.","zh-TW":"文件提供 Online、Community 與 Enterprise 方案，需核對所選版本功能。"}},{"label":{"en":"Developer fit","zh-TW":"開發適配"},"value":{"en":"Our proposed use: build traceable labelled inspection datasets, then export for model training; CVAT itself is not a defect detector.","zh-TW":"本站建議用途：建立可追溯巡檢標註資料再匯出訓練；CVAT 本身不是缺陷偵測器。"}}],"items":[{"id":"sdk","name":"High-level Python API","kind":"SDK","url":"https://docs.cvat.ai/docs/api_sdk/sdk/highlevel-api/","audience":{"en":"Backend / annotation platform","zh-TW":"後端／標註平台"},"capability":{"en":"Manage server projects, tasks and jobs through Python objects.","zh-TW":"以 Python 物件管理伺服器專案、任務與工作。"},"io":{"en":"Server identity and resource IDs → entity objects","zh-TW":"伺服器身分及資源 ID → 實體物件"},"runtime":{"en":"Python client plus selected CVAT server.","zh-TW":"Python client 與選定 CVAT 伺服器。"},"constraint":{"en":"Cached entities can be stale; SDK/server compatibility matters.","zh-TW":"快取實體可能過期，需確認 SDK 與伺服器相容性。"},"validation":{"en":"Fetch again after changes; confirm the organization context before writing.","zh-TW":"變更後重新取得資料，寫入前確認組織環境。"}},{"id":"tasks","name":"Task creation and inspection","kind":"SDK operation","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/tasks/","audience":{"en":"Data intake / annotation lead","zh-TW":"資料收件／標註主管"},"capability":{"en":"Create tasks from registered storage and inspect task data.","zh-TW":"從已註冊儲存建立任務並檢視任務資料。"},"io":{"en":"Image keys and labels → task identity and frames","zh-TW":"影像物件鍵與標籤 → 任務識別與影格"},"runtime":{"en":"CVAT data processing and configured storage.","zh-TW":"CVAT 資料處理與設定儲存。"},"constraint":{"en":"Task creation is not finished annotation; a retry may create a duplicate.","zh-TW":"建立任務不代表完成標註；重試可能建立重複任務。"},"validation":{"en":"Reconcile source manifest, frame count and task ID before assigning work.","zh-TW":"分派前核對來源清單、影格數及任務 ID。"}},{"id":"jobs","name":"Job workflow management","kind":"SDK operation","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/jobs/","audience":{"en":"Annotation supervisor / QA","zh-TW":"標註主管／QA"},"capability":{"en":"Filter jobs and update assignment, stage or state.","zh-TW":"篩選工作並更新分派、階段或狀態。"},"io":{"en":"Job filter and transition → updated job","zh-TW":"工作篩選與轉換 → 更新後工作"},"runtime":{"en":"Server-side annotation workflow.","zh-TW":"伺服器端標註流程。"},"constraint":{"en":"A completed annotation stage is distinct from reviewed acceptance.","zh-TW":"標註階段完成與審核接受不同。"},"validation":{"en":"Test annotation → validation transitions; do not auto-accept unreviewed work.","zh-TW":"測試標註轉驗證，未審核工作不自動接受。"}},{"id":"annotations","name":"Annotation import and editing","kind":"SDK operation","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/annotations/","audience":{"en":"Label migration / ML engineer","zh-TW":"標籤遷移／ML 工程師"},"capability":{"en":"Import annotations and inspect or modify tags, shapes and tracks.","zh-TW":"匯入標註，檢視或修改 tags、shapes 及 tracks。"},"io":{"en":"Labelled archive or edit → stored annotation objects","zh-TW":"標註壓縮檔或編輯 → 儲存標註物件"},"runtime":{"en":"CVAT importer and annotation storage.","zh-TW":"CVAT 匯入器與標註儲存。"},"constraint":{"en":"Label IDs, geometry and frame ordering must match the destination.","zh-TW":"標籤 ID、幾何及影格順序必須符合目的任務。"},"validation":{"en":"Compare pre/post counts and a known box on the correct frame.","zh-TW":"比較前後數量並檢查指定影格上的已知框線。"}},{"id":"exports","name":"Dataset export","kind":"SDK operation","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/datasets/","audience":{"en":"ML training / dataset delivery","zh-TW":"ML 訓練／資料集交付"},"capability":{"en":"Export task or project datasets in a chosen supported format.","zh-TW":"以選定支援格式匯出任務或專案資料集。"},"io":{"en":"Resource and format → dataset archive","zh-TW":"資源與格式 → 資料集壓縮檔"},"runtime":{"en":"Server export to local download or configured storage.","zh-TW":"伺服器匯出至本地下載或設定儲存。"},"constraint":{"en":"Formats can omit unsupported annotation details; archive creation may take time.","zh-TW":"格式可能略過不支援的標註細節；壓縮檔建立需要時間。"},"validation":{"en":"Round-trip a fixture and compare labels, coordinates, frame IDs and media inclusion.","zh-TW":"將樣本匯出再匯入，比較標籤、座標、影格 ID 及媒體內容。"}},{"id":"torch","name":"PyTorch dataset adapter","kind":"Training adapter","url":"https://docs.cvat.ai/docs/api_sdk/sdk/pytorch-adapter/","audience":{"en":"PyTorch training engineer","zh-TW":"PyTorch 訓練工程師"},"capability":{"en":"Expose image tasks or projects as PyTorch datasets.","zh-TW":"將影像任務或專案作為 PyTorch 資料集。"},"io":{"en":"Task/project → image and target samples","zh-TW":"任務／專案 → 影像與目標樣本"},"runtime":{"en":"Local Python cache after server synchronization.","zh-TW":"與伺服器同步後的本地 Python 快取。"},"constraint":{"en":"The documented adapter supports image tasks; do not assume video tasks work.","zh-TW":"文件中的 adapter 支援影像任務，不可假定支援視訊任務。"},"validation":{"en":"Freeze label-to-index mapping and verify train/validation separation.","zh-TW":"固定標籤索引對應，核對訓練與驗證資料分離。"}},{"id":"auto","name":"Auto-annotation API","kind":"Model adapter","url":"https://docs.cvat.ai/docs/api_sdk/sdk/auto-annotation/","audience":{"en":"ML / annotation automation","zh-TW":"ML／標註自動化"},"capability":{"en":"Run annotation functions and map their output to CVAT labels.","zh-TW":"執行標註函式並將輸出對應到 CVAT 標籤。"},"io":{"en":"Model function and frames → proposed annotations","zh-TW":"模型函式與影格 → 建議標註"},"runtime":{"en":"Model execution environment plus CVAT synchronization.","zh-TW":"模型執行環境與 CVAT 同步。"},"constraint":{"en":"Model suggestions still need QA; mismatched class names can corrupt meaning.","zh-TW":"模型建議仍需 QA；類別名稱不符會破壞語意。"},"validation":{"en":"Use a small task; inspect mapped labels and coordinate geometry before scaling.","zh-TW":"先用小任務檢查標籤對應與幾何座標，再擴大。"}},{"id":"storage","name":"Cloud storage registration","kind":"Storage integration","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/cloud-storage/","audience":{"en":"Data platform / infrastructure","zh-TW":"資料平台／基礎設施"},"capability":{"en":"Register cloud storage and its connection settings for CVAT data access.","zh-TW":"註冊雲端儲存與連線設定，供 CVAT 存取資料。"},"io":{"en":"Bucket configuration → registered storage ID","zh-TW":"Bucket 設定 → 已註冊儲存 ID"},"runtime":{"en":"CVAT server to authorized object storage.","zh-TW":"CVAT 伺服器連接授權物件儲存。"},"constraint":{"en":"Reachability from a laptop does not establish server access.","zh-TW":"筆電能存取不代表伺服器能存取。"},"validation":{"en":"Verify a least-privilege test object, expired credentials and manifest freshness.","zh-TW":"驗證最小權限測試物件、過期憑證與清單新鮮度。"}},{"id":"webhooks","name":"Webhook registration and receiver","kind":"Event integration","url":"https://docs.cvat.ai/docs/api_sdk/sdk/examples/webhooks/","audience":{"en":"Backend / workflow orchestration","zh-TW":"後端／工作流程編排"},"capability":{"en":"Subscribe to project or organization events and verify signed deliveries.","zh-TW":"訂閱專案或組織事件並驗證簽章投遞。"},"io":{"en":"Event subscription → signed HTTP payloads","zh-TW":"事件訂閱 → 已簽章 HTTP 資料"},"runtime":{"en":"CVAT server and reachable receiver.","zh-TW":"CVAT 伺服器與可連線接收器。"},"constraint":{"en":"Treat replay and duplicate delivery as possible integration cases.","zh-TW":"將重放與重複投遞列為整合情境。"},"validation":{"en":"Reject a bad signature and make repeated task events idempotent.","zh-TW":"拒絕錯誤簽章，重複任務事件採冪等處理。"}},{"id":"cli","name":"CVAT CLI","kind":"Terminal tooling","url":"https://docs.cvat.ai/docs/api_sdk/cli/","audience":{"en":"Dataset operator / CI engineer","zh-TW":"資料集操作員／CI 工程師"},"capability":{"en":"Run CVAT task and data operations from a terminal.","zh-TW":"從終端機執行 CVAT 任務與資料操作。"},"io":{"en":"CLI arguments and profile → command result","zh-TW":"CLI 參數與設定檔 → 指令結果"},"runtime":{"en":"Workstation or controlled CI worker.","zh-TW":"工作站或受控 CI 執行器。"},"constraint":{"en":"Saved profiles and tokens must not leak into logs or shared artifacts.","zh-TW":"儲存設定檔與 token 不得流入日誌或共用檔案。"},"validation":{"en":"Confirm server and organization; start with a bounded read-only command.","zh-TW":"確認伺服器及組織，先執行有限範圍唯讀指令。"}}],"supporting_references":[{"id":"auth","name":"Access Tokens","url":"https://docs.cvat.ai/docs/api_sdk/access_tokens/","audience":{"en":"Platform owner: token permissions and lifetime.","zh-TW":"平台負責人：token 權限及有效期限。"},"validation":{"en":"Use read-only access for inspection; test expiration and do not log tokens.","zh-TW":"盤點採唯讀權限；測試到期，不記錄 token。"}},{"id":"server","name":"Server API","url":"https://docs.cvat.ai/docs/api_sdk/api/","audience":{"en":"Backend: inspect the actual server API schema.","zh-TW":"後端：檢查實際伺服器 API schema。"},"validation":{"en":"Use the target server version; request success must be followed through asynchronous processing.","zh-TW":"使用目標伺服器版本；請求成功後仍需追蹤非同步處理。"}},{"id":"sdk-root","name":"SDK overview","url":"https://docs.cvat.ai/docs/api_sdk/sdk/","audience":{"en":"ML integrator: distinguish SDK, PyTorch and annotation adapters.","zh-TW":"ML 整合者：區分 SDK、PyTorch 及標註 adapter。"},"validation":{"en":"Pin compatible server/SDK versions and the extras actually needed.","zh-TW":"固定相容伺服器／SDK 版本及實際所需 extras。"}}]},"content_coverage":{"reference_guide":true,"developer_starter":false,"expected_results":true,"integration_test":"not-run","updated_at":"2026-10-08"},"developer_starter":{"version":"1.0.0","verification":"illustrative-contract-only;live-provider-not-run","filename":"CVATAPI-expected-results.json","format":"json-example","scope":{"en":"Illustrative inspection-annotation export contract; no task or annotation was created.","zh-TW":"巡檢標註匯出契約示意，沒有建立任務或標註。"},"setup":{"en":"Agree label vocabulary, frame order and export format before implementation. The JSON is our expected adapter output, not CVAT’s native payload or executed output.","zh-TW":"實作前約定標籤詞彙、影格順序及匯出格式。JSON 為預期轉接器輸出，不是 CVAT 原始回應或執行結果。"},"code":"{\n  \"schema_version\": \"1.0.0\",\n  \"provider\": \"CVAT\",\n  \"status\": \"ok\",\n  \"example\": true,\n  \"contract_origin\": \"Smart Tools illustrative internal contract; not a provider response\",\n  \"input\": {\n    \"task_ref\": \"example-task-42\",\n    \"frame_count\": 2,\n    \"label_schema\": [\n      \"scratch\"\n    ],\n    \"export_format\": \"COCO\"\n  },\n  \"data\": {\n    \"review_state\": \"accepted\",\n    \"frames\": [\n      {\n        \"frame_index\": 0,\n        \"sample_id\": \"panel-A\",\n        \"annotations\": [\n          {\n            \"label\": \"scratch\",\n            \"box_xyxy_pixels\": [\n              10,\n              20,\n              30,\n              40\n            ]\n          }\n        ]\n      },\n      {\n        \"frame_index\": 1,\n        \"sample_id\": \"panel-B\",\n        \"annotations\": [],\n        \"reviewed_empty\": true\n      }\n    ],\n    \"export_state\": \"ready\"\n  },\n  \"error\": null\n}","decisions":[[{"en":"Input requirements","zh-TW":"輸入條件"},{"en":"Authorized images, stable frame IDs, label schema and permission to read the selected task.","zh-TW":"授權影像、穩定影格 ID、標籤 schema 與指定任務讀取權限。"}],[{"en":"Expected success","zh-TW":"預期成功"},{"en":"Return accepted labels only after review and export completion; preserve sample-to-frame mapping.","zh-TW":"審核與匯出完成後才回傳已接受標籤，保留樣本與影格對應。"}],[{"en":"Expected empty","zh-TW":"預期空值"},{"en":"A reviewed negative frame can have annotations=[]; an unreviewed frame remains pending.","zh-TW":"已審核無目標影格可 annotations=[]；未審核影格維持 pending。"}],[{"en":"Expected failure","zh-TW":"預期失敗"},{"en":"Permission, import-format and failed export errors use status=error and data=null, not an empty successful dataset.","zh-TW":"權限、匯入格式或匯出失敗採 status=error、data=null，不冒充空成功資料集。"}],[{"en":"Acceptance","zh-TW":"驗收"},{"en":"Reconcile every frame and round-trip coordinates before training; review state must be independently checked.","zh-TW":"訓練前逐影格核對並來回轉換座標，獨立確認審核狀態。"}],[{"en":"Limitations","zh-TW":"限制"},{"en":"No API call, measured annotation quality or throughput; example coordinates and IDs are invented fixtures.","zh-TW":"沒有 API 呼叫或標註品質／吞吐量實測；座標及 ID 為示例。"}],[{"en":"Data and runtime","zh-TW":"資料與執行環境"},{"en":"Media and annotations reside on the chosen CVAT/storage deployment; local caches and exports need a retention policy.","zh-TW":"媒體與標註位於選定 CVAT／儲存部署，本地快取及匯出檔需保留政策。"}]],"expected_results":[{"scenario":{"en":"Reviewed scratch","zh-TW":"已審核刮痕"},"input":{"en":"Two known frames with one reviewed box.","zh-TW":"兩張已知影格，其中一張有已審核框線。"},"output":{"en":"ok; two mapped frames and one scratch annotation.","zh-TW":"ok；兩張對應影格及一筆 scratch 標註。"},"acceptance":{"en":"Exact sample IDs, geometry and accepted review state.","zh-TW":"樣本 ID、幾何及接受狀態完全相符。"}},{"scenario":{"en":"Reviewed negative","zh-TW":"已審核無目標"},"input":{"en":"A frame explicitly reviewed as no scratch.","zh-TW":"明確審核為無刮痕的影格。"},"output":{"en":"ok; annotations=[] and reviewed_empty=true.","zh-TW":"ok；annotations=[] 且 reviewed_empty=true。"},"acceptance":{"en":"Never infer negative merely from missing labels.","zh-TW":"不因缺少標籤便推定無目標。"}},{"scenario":{"en":"Work unfinished","zh-TW":"工作未完成"},"input":{"en":"Existing task with unreviewed frames.","zh-TW":"包含未審核影格的既有任務。"},"output":{"en":"pending; no training-ready export assertion.","zh-TW":"pending；不宣稱可供訓練。"},"acceptance":{"en":"Every unfinished frame remains distinguishable.","zh-TW":"每張未完成影格皆可辨識。"}},{"scenario":{"en":"Access denied","zh-TW":"存取拒絕"},"input":{"en":"Task outside the authorized organization.","zh-TW":"未獲授權組織中的任務。"},"output":{"en":"error; data=null; permission category.","zh-TW":"error；data=null；權限分類。"},"acceptance":{"en":"No leaked annotations and no empty-success fallback.","zh-TW":"不洩漏標註，也不轉成空成功。"}}]},"schema_version":"1.0.0","type":"development-proposal","product_id":"industrial-api:CVATAPI","name":"CVAT Server API","provider":"CVAT","url":"https://smart-tools.ai/product/CVATAPI","localized_urls":{"en":"https://smart-tools.ai/product/CVATAPI","zh-TW":"https://smart-tools.ai/zh-tw/product/CVATAPI"},"category":"vision","capability_id":"cap:computer-vision","technology_hub":"https://smart-tools.ai/industrial-ai/computer-vision","interface_kind":"API / SDK","deployment":"hybrid","official_documentation":"https://docs.cvat.ai/docs/api_sdk/api/","sources":["https://docs.cvat.ai/docs/api_sdk/api/","https://docs.cvat.ai/docs/getting_started/overview/","https://docs.cvat.ai/docs/api_sdk/sdk/highlevel-api/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/tasks/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/jobs/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/annotations/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/datasets/","https://docs.cvat.ai/docs/api_sdk/sdk/pytorch-adapter/","https://docs.cvat.ai/docs/api_sdk/sdk/auto-annotation/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/cloud-storage/","https://docs.cvat.ai/docs/api_sdk/sdk/examples/webhooks/","https://docs.cvat.ai/docs/api_sdk/cli/","https://docs.cvat.ai/docs/api_sdk/access_tokens/","https://docs.cvat.ai/docs/api_sdk/sdk/"],"source_review":{"level":"P1","status":"official-source-reviewed","checked_at":"2026-10-08"},"provider_summary":{"en":"Manage annotation tasks and data through a server API.","zh-TW":"透過伺服器 API 管理標註任務與資料。"},"proposed_product":{"en":"Inspection annotation queue","zh-TW":"巡檢標註派工工具"},"feasibility":{"tier":"prototype","rationale":{"en":"Test one documented operation with a small real sample after access is confirmed. This is a development judgment, not a delivery estimate.","zh-TW":"確認存取後，用少量真實樣本測試一個有文件的操作。此為開發判斷，不是交期估算。"},"basis":"development-judgment;not-traffic-ranked"},"proposed_inputs":{"en":"A small authorized image dataset, task definition and reference annotations.","zh-TW":"少量經授權影像、任務定義與參考標註。"},"proposed_deliverable":{"en":"A reviewable result with image references, labels or annotation state; keep original files.","zh-TW":"可審核的影像引用、標籤或標註狀態；保留原始檔案。"},"acceptance_criterion":{"en":"Compare the supported operation against a labeled sample; report errors and missing results separately.","zh-TW":"用已標註樣本比對支援的操作；錯誤與缺漏結果分開呈現。"},"dependencies":{"en":"Dataset access, image rights and a supported model or annotation project.","zh-TW":"資料集存取、影像使用權與支援的模型或標註專案。"},"integration_condition":null,"proposed_adapter_envelope":{"provider":"CVAT","operation":"chosen-documented-operation","source_url":"https://docs.cvat.ai/docs/api_sdk/api/","captured_at":"ISO-8601 timestamp","status":"ok|pending|unknown|failed","data":"provider response mapped by the team","evidence":"source references","errors":"explicit error details"},"adapter_envelope_status":"proposed-internal-contract;not-a-provider-response","development_status":"concept-specification","integration_test":"not-run","pricing_status":"provider-terms-review-required","estimate_status":"requires-access-and-sample-validation","traffic_status":"not-measured-in-this-assessment","measurement_events":["product_view","product_to_docs","product_to_spec","bridge_to_industrial_ai"]}