GET
/
v1
/
testset
/
{testset_id}
/
schema
curl --request GET \
  --url https://api.getscorecard.ai/v1/testset/{testset_id}/schema \
  --header 'X-API-Key: <api-key>'
{
  "variables": [
    {
      "data_type": "file_url",
      "description": "example file url",
      "name": "example_file_url",
      "role": "input"
    },
    {
      "data_type": "json_object",
      "description": "example json object",
      "name": "example_json_object",
      "role": "output"
    },
    {
      "data_type": "text",
      "description": "example text",
      "name": "example_text",
      "role": "label"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testset_id
integer
required

The ID of the Testset to retrieve the schema from.

Example:

123

Response

200
application/json
Successful Response

Custom schema model with an ordered list of custom variables.

​
variables
object[]

Ordered list of custom variables

Custom variable model with name, description, role and data type.

Example:
[
  {
    "data_type": "file_url",
    "description": "example file url",
    "name": "example_file_url",
    "role": "input"
  },
  {
    "data_type": "json_object",
    "description": "example json object",
    "name": "example_json_object",
    "role": "output"
  },
  {
    "data_type": "text",
    "description": "example text",
    "name": "example_text",
    "role": "label"
  }
]

Was this page helpful?