Checks if a photo has a specific label.

GET/photo/checkPhotoLabel

Authentication

Include your API key in the x-api-key header on every request.

Query parameters

photoIdstringrequired

labelstringrequiredmin 1max 40

Response · 200 Label check result

dataobjectrequired

hasLabelbooleanrequired

Whether or not the photo has the specified label

warningsArray<string>

string

Errors

400Invalid request. The request was malformed or missing required parameters.

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.photo.checkPhotoLabel({
  photoId: "44444444-4444-4444-4444-444444444444",
  label: "Vacation"
});

cURLbash

curl "https://public-api.joinswsh.com/photo/checkPhotoLabel?photoId=44444444-4444-4444-4444-444444444444&label=Vacation" \
  -H "x-api-key: $SWSH_API_KEY"

Example response

{"data": {"hasLabel": true
},
"warnings": ["Example warning"
]
}