Skip to Content
APIEndpointsList tags

List tags

Tags are free-form labels on prompts, independent of the topic tree. Where a prompt has exactly one topic, it can carry any number of tags — so tags are how you slice the same prompts a second way, by persona, campaign, funnel experiment, or anything else.

These ids are the values for the tag_id filter elsewhere on the surface.

GET /v1/brands/{brand_id}/tags

Authorization

HeaderTypeRequired
AuthorizationBearer asky_sk_…required

Path parameters

ParameterTypeRequiredDescription
brand_iduuidrequiredFrom List brands

Query parameters

ParameterTypeRequiredDescription
limitintegeroptionalRows per page, 1 to 100. Defaults to 20.
cursorstringoptionalOpaque cursor from the previous response. Treat it as a token, never construct one.

Request

curl --request GET \ --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/tags' \ --header 'Authorization: Bearer <api-key>'

Response

{ "data": [ { "id": "1f8c2a5e-9d40-4b17-8e6a-3c05b91e7d22", "name": "Bottom funnel", "slug": "bottom-funnel", "color": "emerald", "description": "Prompts with clear purchase intent" } ], "pagination": { "limit": 20, "has_more": true, "next_cursor": "eyJ2IjoxLCJvIjoyMCwibCI6MjB9" }, "request_id": "req_c0a3f5d81b6e4297a4de" }

Response fields

FieldTypeDescription
data.tagsobject[]required
data.tags[].iduuidrequired. Use as tag_id in filters
data.tags[].namestringrequired. Display name
data.tags[].slugstringrequired. URL-safe form of the name
data.tags[].colorstring | nullDisplay colour token
data.tags[].descriptionstring | null
data.countintegerrequired
request_idstringrequired. Also returned as the x-request-id header. Quote it when contacting support

Errors

StatusCodeWhen
400invalid_requestA parameter is unknown or malformed. The message names it
401invalid_tokenThe key is missing, malformed, or does not exist
401token_expiredThe key passed its expiry date
401token_revokedThe key was revoked
404not_foundThe brand does not exist, or this key is not allowed to reach it. The two are deliberately indistinguishable
429rate_limitedOver 300 requests per minute. See the Retry-After header

Notes

Not paginated.

Last updated on