Predictors
Retrieve a Predictor
Predictors
Retrieve a Predictor
GET
/
v1
/
predictors
/
{tag}
curl --request GET \
--url https://api.fxn.ai/v1/predictors/{tag} \
--header 'Authorization: Bearer <token>'
{
"tag": "<string>",
"owner": {
"username": "<string>",
"created": "<string>"
},
"name": "<string>",
"description": "<string>",
"card": "<string>",
"status": "<string>",
"access": "<string>",
"signature": {
"inputs": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"optional": true,
"range": {},
"enumeration": [
{
"name": "<string>",
"value": {}
}
],
"defaultValue": {},
"schema": {}
}
],
"outputs": [
{
"name": "<string>",
"type": "<string>",
"enumeration": [
{
"name": "<string>",
"value": {}
}
],
"schema": {}
}
]
}
}
Parameters
Predictor tag.
Response
Predictor tag.
Predictor name.
Predictor description.
Predictor card.
Predictor status.
Predictor access.
Predictor signature.
Predictor inputs.
Parameter name.
Parameter data type.
Parameter description.
Whether the parameter is optional.
Parameter range for numeric parameters.
Parameter default value.
Parameter JSON schema.
This is only populated for list
and dict
parameters.
Predictor outputs.
Parameter name.
Parameter data type.
Parameter JSON schema.
This is only populated for list
and dict
parameters.
curl --request GET \
--url https://api.fxn.ai/v1/predictors/{tag} \
--header 'Authorization: Bearer <token>'
{
"tag": "<string>",
"owner": {
"username": "<string>",
"created": "<string>"
},
"name": "<string>",
"description": "<string>",
"card": "<string>",
"status": "<string>",
"access": "<string>",
"signature": {
"inputs": [
{
"name": "<string>",
"type": "<string>",
"description": "<string>",
"optional": true,
"range": {},
"enumeration": [
{
"name": "<string>",
"value": {}
}
],
"defaultValue": {},
"schema": {}
}
],
"outputs": [
{
"name": "<string>",
"type": "<string>",
"enumeration": [
{
"name": "<string>",
"value": {}
}
],
"schema": {}
}
]
}
}