Retrieve a specific face

Retrieve detailed information for a specific face by providing its unique ID.

GET

Parameters

Path Parameters

FaceId
REQUIRED
Unique identifier of the face
Status codeDescription
200Face details successfully retrieved.
400Bad request error - the request contains invalid parameters or malformed data
404Resource not found - the requested resource does not exist
500Internal server error - an unexpected error occurred on the server
cURL
curl -L \
"https://blockv-labs.io/faces/{faceId}" \
-H 'Accept: application/json'
Response
{
"id": "string",
"name": "string",
"url": "string",
"content": "string",
"assets": [
{
"id": "string",
"name": "string",
"type": "string",
"url": "string",
"hash": "string",
"is_public": false,
"when_created": "2024-01-01T00:00:00Z"
}
],
"when_created": "2024-01-01T00:00:00Z",
"when_modified": "2024-01-01T00:00:00Z"
}
json
{
"type": "object",
"description": "Face entity representing a visual interface or template for smart objects",
"required": [
"id",
"name",
"when_created",
"when_modified"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the face",
"x-oapi-codegen-extra-tags": {
"bson": "_id",
"json": "id"
},
"x-go-type": "id.ID",
"x-go-type-import": {
"path": "github.com/vlabsio/smarttoken/pkg/types/id"
},
"x-go-type-skip-optional-pointer": true
},
"name": {
"type": "string",
"description": "Name of the face.",
"x-oapi-codegen-extra-tags": {
"bson": "name",
"validate": "required,max=255"
}
},
"url": {
"type": "string",
"description": "URL of the face, typically pointing to an image or resource.",
"x-oapi-codegen-extra-tags": {
"bson": "url,omitempty"
}
},
"content": {
"type": "string",
"description": "Content of the face.",
"x-oapi-codegen-extra-tags": {
"bson": "content,omitempty"
}
},
"config": {
"type": "object",
"description": "Optional configuration data for customizing the face.",
"additionalProperties": true,
"x-oapi-codegen-extra-tags": {
"bson": "config"
}
},
"assets": {
"type": "array",
"description": "List of resources required or utilized by the face.",
"items": {
"type": "object",
"description": "Represents a file or media asset stored in the platform",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the asset",
"x-oapi-codegen-extra-tags": {
"bson": "id,omitempty"
}
},
"name": {
"type": "string",
"description": "Human-readable name of the asset",
"x-oapi-codegen-extra-tags": {
"bson": "name,omitempty"
}
},
"type": {
"type": "string",
"description": "MIME type of the asset (e.g., image/jpeg, application/pdf)",
"x-oapi-codegen-extra-tags": {
"bson": "type,omitempty"
}
},
"url": {
"type": "string",
"description": "Public URL where the asset can be accessed",
"x-oapi-codegen-extra-tags": {
"bson": "url,omitempty"
}
},
"hash": {
"type": "string",
"description": "Cryptographic hash of the asset content for integrity verification",
"x-oapi-codegen-extra-tags": {
"bson": "hash,omitempty"
}
},
"is_public": {
"type": "boolean",
"description": "Whether the asset is publicly accessible without authentication",
"x-oapi-codegen-extra-tags": {
"bson": "is_public,omitempty"
}
},
"when_created": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the asset was uploaded",
"x-oapi-codegen-extra-tags": {
"bson": "when_created,omitempty"
}
}
}
},
"x-oapi-codegen-extra-tags": {
"bson": "assets"
},
"x-go-type-skip-optional-pointer": true
},
"when_created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the face was created.",
"x-oapi-codegen-extra-tags": {
"bson": "when_created"
}
},
"when_modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last modification to the face.",
"x-oapi-codegen-extra-tags": {
"bson": "when_modified"
}
}
}
}