Logo training allows you to train LogoGrab’s model to identify specific brand logos.
To verify that a logograb api key has been setup (not check it’s validity) - e.g. use this first before attempting to call other logo training endpoints:
OPTIONS /api/data/train/logos
{
"can_train_logos": true
}
Get a summary of logo training requests that have already been submitted
GET /api/data/train/logos
{
"logo_training_requests": [
{
"logo_training_request_id": "12c0486d-77e6-4f4e-9760-dc3e9f5166e0",
"name": "Brand Name 1",
"website": "http://brandname1.com/",
"training_complete": false,
"created_at": "2018-08-22T23:53:12.984862Z",
"last_checked_for_completion_at": "2018-08-23T00:09:19.282854Z"
}
]
}
GET /api/data/train/logos/{logo_training_id}
{
"logo_training_request_id": "12c0486d-77e6-4f4e-9760-dc3e9f5166e0",
"name": "ACME Company",
"website": "http://acmecompany.com/",
"training_complete": false,
"requested_by": {
"id": "5b7df128bd8d9ba5673cab7801468e4f",
"email": "admin@mycompany.com",
"first_name": "Admin",
"last_name": "User",
"avatar": "/path/to/avatar.jpg"
},
"created_at": "2018-08-22T23:53:12.984862Z",
"last_checked_for_completion_at": "2018-08-23T00:09:19.282854Z",
"logo_images": [
{
"logo_training_image_id": "cc3d3972-deb5-4b4c-b5d0-092a26a4a7ae",
"public_url": "https://path-to-s3.com/image.jpg",
"file_path": "/files/495ebe237185467138355f6714ee33f6/logos/52b11960-ed0d-4227-a737-7c6a1355e34e.jpeg",
"created_at": "2018-08-22T23:53:12.984862Z"
},
{
"logo_training_image_id": "12badb7b-8fed-4c3a-afc3-e422a08c8ec9",
"public_url": "https://path-to-s3.com/image.jpg",
"file_path": "/files/495ebe237185467138355f6714ee33f6/logos/3dd8bf58-09d4-43e3-870d-25f2b10f761e.jpeg",
"created_at": "2018-08-22T23:53:12.984862Z"
}
]
}
Check in with logograb on the activation status of a pending logo training request
GET /api/data/train/logos/{logo_training_id}/status
{
"logo_training_request_id": "12c0486d-77e6-4f4e-9760-dc3d825166e0",
"training_complete": true,
"last_checked_for_completion_at": "2018-08-23T17:11:18.3260818Z"
}
Send a multipart form request, with AT LEAST 1 reference logo image in jpeg/png format:
POST /api/data/train/logos
{
"name": "ACME Consulting",
"website": "https://acmeconsulting.biz",
"logos": [
jpeg/png file...
jpeg/png file...
]
}
{
"logo_training_request_id": "4bed6c11-ccf6-4814-93bc-9ef78282bcf3",
"name": "ACME Consulting",
"website": "https://acmeconsulting.biz",
"training_complete": false,
"requested_by": {
"id": "5b7df128bd014925673cab7801468e4f",
"email": "admin@acmeconsulting.biz",
"first_name": "Acme",
"last_name": "Consultant",
"avatar": "/path/to/avatar.png"
},
"created_at": "2018-08-23T17:17:14.9941678Z",
"last_checked_for_completion_at": "2018-08-23T17:17:14.9941678Z",
"logo_images": [
{
"logo_training_image_id": "b63df21a-4dc7-4706-ba68-8ca1fbbf9fcc",
"public_url": "https://path-to-s3.com/image.jpg",
"file_path": "/files/98c4522d64a5a7728cbd6ea20ca99182/logos/40233b4e-c691-4da8-976e-4862caedba5c.jpeg",
"created_at": "0001-01-01T00:00:00Z"
},
{
"logo_training_image_id": "cd4ba3d4-5cb1-437c-857c-a6df37b77930",
"public_url": "https://path-to-s3.com/image.jpg",
"file_path": "/files/98c4522d64a5a7728cbd6ea20ca99182/logos/66daa820-6442-4143-bf68-3983204430d3.jpeg",
"created_at": "0001-01-01T00:00:00Z"
}
]
}
This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.
© 2021 GrayMeta, Inc.