Create GeneratedTest

POST

/generated-tests

Request

Query Params

Body Params application/vnd.api+jsonRequired

Example

{
    "data": {
        "type": "GeneratedTest",
        "attributes": {
            "source": {
                "type": "collection",
                "objectId": "string"
            },
            "length": 0,
            "tagFilters": {},
            "tagSetId": "string"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/generated-tests?include' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "GeneratedTest",
        "attributes": {
            "source": {
                "type": "collection",
                "objectId": "string"
            },
            "length": 0,
            "tagFilters": {},
            "tagSetId": "string"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

Example

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

Modified at 2025-09-30 10:40:38

Get GenerateTestJob

Create QuestionExport