Kits
Get a kit
Returns a kit by its identifier: name, description, image, collection and tags.
Request examples
curl https://app.filmo.io/api/v1/kits/kit_8f2a1c \
--header "Authorization: Bearer $FILMO_API_KEY"Generated from the schema
It does NOT return the items that compose it — the internal read does not guarantee them, and publishing a field that is sometimes missing is worse than not publishing it.
Authorizations
Bearer API key with the scope below. kits:read
Headers
Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.
Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
Path parameters
Kit identifier.
Limits: min length 1
Response
Successful response.
Response schema: KitDto
Envelope: KitResponse. meta. is present only when the operation is deprecated.
Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag
Named group of items that go out together.
Show child attributesHide child attributes
Unique identifier of the kit.
Kit name.
Kit description; null if it has none.
URL of the main image; null if it has none.
Collection it belongs to; null if it is in none.
Full path of the collection; null if it is in none.
Items that make up the kit, in display order.
Show child attributesHide child attributes
Identifier of the item; read it in /api.
Item name, as recorded when it was added to the kit.
Variant of the item, if one was chosen; null otherwise.
Name of that variant; null if none.
How many units of the item the kit includes.
Display order inside the kit (0-based); null if not set.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
Additional information about the response.
Show child attributesHide child attributes
Lifecycle warnings; present only when the operation is deprecated.
Show child attributesHide child attributes
Stable warning code.
Available options: deprecated
For people: what is deprecated, until when, and what to use.
Day (YYYY-MM-DD) the operation stops being served.
operationId of the operation to use instead, or null if there is none.
Where the deprecation is documented (the changelog).
Not modified: the If-None-Match sent matches the current ETag. No body; the copy you have is current.
Headers: ETag
No body.
Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin).
Headers: X-Request-Id · Content-Language
Not allowed (insufficient_scope: the API key does not have the required scope, named in requiredScope; forbidden: the owner of the key lacks the permission the operation requires). insufficient_scope is answered before the request counts against the rate limit, so it carries no RateLimit-* headers; forbidden does.
Headers: X-Request-Id · Content-Language
Resource not found (not_found): it does not exist or is outside the scope of the API key.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Rate limit exceeded (rate_limited): retry after Retry-After seconds; RateLimit-* says which quota ran out.
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · Retry-After
Internal error (internal_error).
Headers: X-Request-Id · Content-Language · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset
Errors
Deprecation
This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy
Related
Related pages
Link to this section: Related pagesCatalog & inventory
Kit
Named group of items that go out together.
Was this page helpful?