# README
title: "Numbers Protocol" lang: "en-US" draft: false description: "Learn about how to set up a VDP Numbers Protocol component https://github.com/instill-ai/instill-core"
The Numbers Protocol component is an application component that allows users to seamlessly integrate third-party blockchain services through the Numbers Protocol, providing security, verifiability and traceability to data management. It can carry out the following tasks:
Release Stage
Alpha
Configuration
The component definition and tasks are defined in the definition.json and tasks.json files respectively.
Setup
In order to communicate with Numbers Protocol, the following connection details need to be
provided. You may specify them directly in a pipeline recipe as key-value pairs
within the component's setup
block, or you can create a Connection from
the Integration Settings
page and reference the whole setup
as setup: ${connection.<my-connection-id>}
.
Field | Field ID | Type | Note |
---|---|---|---|
Capture token (required) | capture-token | string | Fill in your Capture token in the Capture App. To access your tokens, you need a Capture App account and you can sign in with email or wallet to acquire the Capture Token. |
Supported Tasks
Register
Register a file into NumbersProtocol Chain.
Input | ID | Type | Description |
---|---|---|---|
Task ID (required) | task | string | TASK_REGISTER |
Images (required) | images | array[string] | The images you want to upload to blockchain. |
Caption | caption | string | Caption of the asset. |
Asset Creator | asset-creator | string | Name of the asset creator. |
Headline | headline | string | Headline of the asset |
Digital Source Type | digital-source-type | string | Specify the type of the source. More details here |
Generated By | generated-by | string | The AI model used to generate the content. |
License | license | object | License |
Mining Preference | mining-preference | string | Designates the selection made by the asset creators or licensed owners to decide if the asset is suitable for inclusion in a data mining or AI/ML training workflow. More details here |
Input Objects in Register
License
License
Field | Field ID | Type | Note |
---|---|---|---|
License Document | document | string | URL of the license file. |
License Name | name | string | License of the asset file. |
Output | ID | Type | Description |
---|---|---|---|
Asset Urls | asset-urls | array[string] | Asset Urls |