Standard
To ensure seamless integration and interoperability, it is recommended that all Exchange Oracles that want their jobs listed in HUMAN App adhere to certain endpoint standards.
Last updated
To ensure seamless integration and interoperability, it is recommended that all Exchange Oracles that want their jobs listed in HUMAN App adhere to certain endpoint standards.
Last updated
© 2023 HPF. HUMAN Protocol® is a registered trademark
The interaction between the annotation tool and the Exchange Oracle is unique for each annotation tool, and therefore, it is not outlined in this document.
OPTIONAL
)POST
/register
Used for registering a user in Exchange Oracle. If an additional registration process is needed, Exchange Oracle operator must store two additional parameters in KVStore:
registration_needed: true
registration_instructions: URL
Headers
Name | Value |
---|---|
Response
POST
/webhook
Used for receiving notifications about various events within the Protocol
GET
/job
Allows retrieving a list of jobs available to be solved
POST
/assignment
Request to get a job assigned to a specific user
GET
/assignment
Allows retrieving a list of jobs assigned to a specific worker
POST
/assignment/resign
This endpoint should be called when a user who has been assigned a job decides they no longer want to solve it.
GET
/stats/assignment
Request to get assignment stats for the worker that sends the request.
GET
/stats
Oracle statistics
This is an open endpoint, but rate limiter should be applied
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|