---
title: "API JSON Schema"
slug: "api-schema"
updated: 2021-11-10T09:48:45Z
published: 2021-11-10T09:48:45Z
canonical: "docs.safetypooldb.ai/api-schema"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.safetypooldb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API JSON Schema

The following are definitions of the data types returned from the API.

## Session Token

The following is returned from [createtoken](/v1/docs/api).

```json
{
    "$id": "https://safetypooldb.ai/sessiontoken.schema.json",
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "title": "Session Token",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "token": {
            "type": "string"
        },
        "expiry": {
            "type": "string",
            "format": "date-time"
        }
    },
    "required": ["token","expiry"]
}
```

## Scenario

Scenarios are returned using the [ASAM OpenLABEL standard](https://www.asam.net/project-detail/asam-openlabel-v100/#backToFilters).

## Scenario File List

```json
{
    "$id": "https://safetypooldb.ai/scenariofilelist.schema.json",
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "title": "Scenario File List",
    "$defs": {
        "scenarioFile": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
            "fileId": {
                "type": "string",
                "format": "uuid"
            },
            "fileName": {
                "type": "string"
            },
            "fileSize": {
                "type": "integer"
            }
        },
        "required": [
            "fileId",
            "fileName",
            "fileSize"
        ]}
    },    
    "type": "array",
    "items": {
        "$ref": "#/$defs/scenarioFile"
    }
}
```

## Test Suite

```json
{
    "$id": "https://safetypooldb.ai/testsuite.schema.json",
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "title": "Test Suite",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "testsuiteId": {
            "type": "integer"
        },
        "name": {
            "type": "string"
        },
        "description": {
            "type": ["string", "null"]
        },
        "scenarios": {
            "type": "array",
            "items": {
                "type": "string"
            }
        }        
    },
    "required": ["testsuiteId","name"]
}
```

## Test Suites

```json
{
    "$id": "https://safetypooldb.ai/testsuites.schema.json",
    "$schema": "https://json-schema.org/draft/2019-09/schema",
    "title": "Test Suites",
    "type": "array",
    "items": {
        "$ref": "https://safetypooldb.ai/testsuite.schema.json"
    }
}
```

##