Microsoft

Custom Vision Training Client

Custom Vision Training Client endpoints from Microsoft

Developer tools#openapi#developer-tools#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Custom Vision Training Client endpoints from Microsoft

Endpoints 48

DomainsApi

  • GETGet a list of the available domains./domains
  • GETGet information about a specific domain./domains/:domainId

ProjectApi

  • GETGet your projects./projects
  • POSTCreate a project./projects?name=My New Project&description=A test project&domainId=ee85a74c-405e-4adc-bb47-ffa8ca0c9f31&classificationType=Multiclass&targetExportPlatforms=CoreML
  • POSTImports a project./projects/import?token=token
  • GETGet a specific project./projects/:projectId
  • DELETEDelete a specific project./projects/:projectId
  • PATCHUpdate a specific project./projects/:projectId
  • GETExports a project./projects/:projectId/export
  • GETGet iterations for the project./projects/:projectId/iterations
  • GETGet a specific iteration./projects/:projectId/iterations/:iterationId
  • DELETEDelete a specific iteration of a project./projects/:projectId/iterations/:iterationId
  • PATCHUpdate a specific iteration./projects/:projectId/iterations/:iterationId
  • GETGet the list of exports for a specific iteration./projects/:projectId/iterations/:iterationId/export
  • POSTExport a trained iteration./projects/:projectId/iterations/:iterationId/export?platform=TensorFlow&flavor=Linux
  • GETGet detailed performance information about an iteration./projects/:projectId/iterations/:iterationId/performance?threshold=0.9&overlapThreshold=0.0
  • GETGet image with its prediction for a given project iteration./projects/:projectId/iterations/:iterationId/performance/images?tagIds=&orderBy=Newest&take=50&skip=0This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to…
  • GETGets the number of images tagged with the provided {tagIds} that have prediction results from training for the provided iteration {iterationId}./projects/:projectId/iterations/:iterationId/performance/images/count?tagIds=b5f7e6a2-a481-49a6-afec-a7cef1af3544The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat…
  • POSTPublish a specific iteration./projects/:projectId/iterations/:iterationId/publish?publishName=Model1&predictionId=/subscriptions/{subscription}/resourceGroups/{resource group name}/providers/Microsoft.CognitiveServices/accounts/{resource name}
  • DELETEUnpublish a specific iteration./projects/:projectId/iterations/:iterationId/publish
  • POSTQueues project for training./projects/:projectId/train?trainingType=Regular&reservedBudgetInHours=0&forceTrain=false&notificationEmailAddress=string

ImageApi

  • POSTAdd the provided images to the set of training images./projects/:projectId/images?tagIds=b607964f-7bd6-4a3b-a869-6791fb6aab87This API accepts body content as multipart/form-data and application/octet-stream. When using multipart multiple image files can be sent at once, with a…
  • DELETEDelete images from the set of training images./projects/:projectId/images?imageIds=e31a14ab-5d78-4f7b-a267-3a1e4fd8a758,cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12&allImages=true&allIterations=true
  • POSTAdd the provided batch of images to the set of training images./projects/:projectId/images/filesThis API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
  • GETGet images by id for a given project iteration./projects/:projectId/images/id?imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.
  • POSTAdd the specified predicted images to the set of training images./projects/:projectId/images/predictionsThis API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.
  • POSTCreate a set of image regions./projects/:projectId/images/regionsThis API accepts a batch of image regions, and optionally tags, to update existing images with region information. There is a limit of 64 entries in the batch.
  • DELETEDelete a set of image regions./projects/:projectId/images/regions?regionIds=
  • POSTGet untagged images whose suggested tags match given tags. Returns empty array if no images are found./projects/:projectId/images/suggested?iterationId=b7b9d99c-a2c6-4658-9900-a98d2ff5bc66This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
  • POSTGet count of images whose suggested tags match given tags and their probabilities are greater than or equal to the given threshold. Returns count as 0 if none found./projects/:projectId/images/suggested/count?iterationId=b7b9d99c-a2c6-4658-9900-a98d2ff5bc66This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
  • GETGet tagged images for a given project iteration./projects/:projectId/images/tagged?iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&orderBy=Newest&take=50&skip=0This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to…
  • GETGets the number of images tagged with the provided {tagIds}./projects/:projectId/images/tagged/count?iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat…
  • POSTAssociate a set of images with a set of tags./projects/:projectId/images/tags
  • DELETERemove a set of tags from a set of images./projects/:projectId/images/tags?imageIds=e31a14ab-5d78-4f7b-a267-3a1e4fd8a758,cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12&tagIds=e31a14ab-5d78-4f7b-a267-3a1e4fd8a758,cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12
  • GETGet untagged images for a given project iteration./projects/:projectId/images/untagged?iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12&orderBy=Newest&take=50&skip=0This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to…
  • GETGets the number of untagged images./projects/:projectId/images/untagged/count?iterationId=cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the current workspace is used.
  • POSTAdd the provided images urls to the set of training images./projects/:projectId/images/urlsThis API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.

ImageRegionProposalApi

  • POSTGet region proposals for an image. Returns empty array if no proposals are found./projects/:projectId/images/:imageId/regionproposalsThis API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.

PredictionsApi

  • DELETEDelete a set of predicted images and their associated prediction results./projects/:projectId/predictions?ids=e31a14ab-5d78-4f7b-a267-3a1e4fd8a758,cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12
  • POSTGet images that were sent to your prediction endpoint./projects/:projectId/predictions/query
  • POSTQuick test an image./projects/:projectId/quicktest/image?iterationId=fe1e83c4-6f50-4899-9544-6bb08cf0e15a&store=true
  • POSTQuick test an image url./projects/:projectId/quicktest/url?iterationId=fe1e83c4-6f50-4899-9544-6bb08cf0e15a&store=true

TagsApi

  • GETGet the tags for a given project and iteration./projects/:projectId/tags?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • POSTCreate a tag for the project./projects/:projectId/tags?name=Tag1&description=Description of Tag1&type=Regular
  • GETGet information about a specific tag./projects/:projectId/tags/:tagId?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6
  • DELETEDelete a tag from the project./projects/:projectId/tags/:tagId
  • PATCHUpdate a tag./projects/:projectId/tags/:tagId

SuggestTagsAndRegionsApi

  • POSTSuggest tags and regions for an array/batch of untagged images. Returns empty array if no tags are found./projects/:projectId/tagsandregions/suggestions?iterationId=4d6eb844-42ee-42bc-bd6f-c32455ef07c9&imageIds=e7f08c23-9e54-49f7-b609-69a0240ba306,ce632666-4b66-4adb-aa0a-ad8b7c32df06This API will get suggested tags and regions for an array/batch of untagged images along with confidences for the tags. It returns an empty array if no tags…

API details

Base URL
https://southcentralus.api.cognitive.microsoft.com/customvision/v3.2/training
Authentication
An API key in the Training-Key header
Operations
48 operations on 35 pathsPOST 19GET 18DELETE 8PATCH 3
Main resources
ProjectApi 19ImageApi 16TagsApi 5PredictionsApi 4DomainsApi 2ImageRegionProposalApi 1SuggestTagsAndRegionsApi 1
Response formats
application/json application/xml text/xml */*
Description format
OpenAPI 3.0.0, API version 3.2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Custom Vision Training Client in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Custom Vision Training Client collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Training-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get a list of the available domains.” (GET /domains), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Custom Vision Training Client?

Custom Vision Training Client endpoints from Microsoft It is listed under Developer tools and has 48 endpoints.

Who publishes the Custom Vision Training Client?

It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Custom Vision Training Client?

Requests go to https://southcentralus.api.cognitive.microsoft.com/customvision/v3.2/training. Endpoint paths are added to this base URL.

How do I authenticate with the Custom Vision Training Client?

With an API key in the Training-Key header.

How many endpoints does the Custom Vision Training Client have?

48 operations on 35 paths (19 POST, 18 GET, 8 DELETE, 3 PATCH). The largest groups are ProjectApi, ImageApi, TagsApi, PredictionsApi.

Is forking the Custom Vision Training Client free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.