Get creative library metadata

GET /api/library/{kind}/{slug}

Read metadata for an active library item. Fetch its content separately.

Authentication

No authentication is required by this operation.

Parameters

Parameter	Location	Type	Required	Description and constraints
kind	path	"examples" / "design-templates" / "canvas-presets" / "shapes"	Yes
slug	path	string	Yes

Request

The shell examples read credentials from ZVID_API_KEY (or ZVID_ACCESS_TOKEN for Bearer authentication). Set that variable in your environment. Replace sample project, template, job, and asset identifiers with values from your own account.

This operation does not take a request body.

Request example

curl --request GET 'https://api.zvid.io/api/library/YOUR_KIND/YOUR_SLUG'

Responses

HTTP 200

Successful response

Content type: application/json.

Required properties: kind, slug, title.

Field	Type	Required	Description and constraints
response.kind	string	Yes
response.slug	string	Yes
response.title	string	Yes
response.description	string	No
response.meta	object OR null	No	At least one listed alternative must match.
response.version	integer	No
response.sortOrder	integer	No
response.status	string	No
response.contentUrl	string	No	Omitted for premium items; use the content endpoint.
response.contentHash	string	No
response.createdAt	string	No
response.updatedAt	string	No

Nested field: response.meta

At least one listed alternative must match.

anyOf alternative 1

Type: object.

anyOf alternative 2

Type: null.

HTTP 400

Invalid input or semantic validation error

Content type: application/json.

Required properties: error.

Field	Type	Required	Description and constraints
response.error	string	Yes
response.message	string	No
response.details	array of object	No
response.planLimits	object	No	Present on render validation errors; contains the authenticated user's current render limits.

Nested field: response.details

Array item: response.details[]

Unknown properties are rejected. Required properties: field, message.

Field	Type	Required	Description and constraints
response.details[].field	string	Yes
response.details[].message	string	Yes

HTTP 401

Missing or invalid credentials

Content type: application/json.

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
response.error	string	Yes	Error type
response.message	string	No	Human-readable error message

HTTP 404

Not found for this account

Content type: application/json.

Required properties: error.

Field	Type	Required	Description and constraints
response.error	string	Yes	Error type
response.message	string	No	Human-readable error message

HTTP 500

Server error

Content type: application/json.

Required properties: error.

Field	Type	Required	Description and constraints
response.error	string	Yes	Error type
response.message	string	No	Human-readable error message

Schema definitions

The following definitions describe the fields referenced above. Expand a definition to inspect its complete contract.

LibraryItem

Required properties: kind, slug, title.

Field	Type	Required	Description and constraints
LibraryItem.kind	string	Yes
LibraryItem.slug	string	Yes
LibraryItem.title	string	Yes
LibraryItem.description	string	No
LibraryItem.meta	object OR null	No	At least one listed alternative must match.
LibraryItem.version	integer	No
LibraryItem.sortOrder	integer	No
LibraryItem.status	string	No
LibraryItem.contentUrl	string	No	Omitted for premium items; use the content endpoint.
LibraryItem.contentHash	string	No
LibraryItem.createdAt	string	No
LibraryItem.updatedAt	string	No

Nested field: LibraryItem.meta

At least one listed alternative must match.

anyOf alternative 1

Type: object.

anyOf alternative 2

Type: null.

ValidationError

Required properties: error.

Field	Type	Required	Description and constraints
ValidationError.error	string	Yes
ValidationError.message	string	No
ValidationError.details	array of object	No
ValidationError.planLimits	object	No	Present on render validation errors; contains the authenticated user's current render limits.

Nested field: ValidationError.details

Array item: ValidationError.details[]

Unknown properties are rejected. Required properties: field, message.

Field	Type	Required	Description and constraints
ValidationError.details[].field	string	Yes
ValidationError.details[].message	string	Yes

AuthenticationError

Unknown properties are rejected. Required properties: error.

Field	Type	Required	Description and constraints
AuthenticationError.error	string	Yes	Error type
AuthenticationError.message	string	No	Human-readable error message

Error

Required properties: error.

Field	Type	Required	Description and constraints
Error.error	string	Yes	Error type
Error.message	string	No	Human-readable error message

Related resources

• OpenAPI specification
• Project payload schema
• Quick Start
• Authentication guide