Create a test suite

Create an empty test suite. Add cases with add_test_cases, then publish_test_suite to make version 1 runnable.

POST/v1/projects/{projectId}/test-suites

Authorization

AuthorizationPersonal API key · headerrequired

Your personal API key from Settings > Personal API Keys, sent as Bearer <key>.

X-Organization-IdOrganization ID · headerrequired

The organization to act in. Copy it with Copy organization ID in the organization menu or the settings sidebar.

Path parameters

projectIdstring<uuid>required

Request body

requiredapplication/json

namestringrequired

min length 1 · max length 200 · matches ^\S(?:[\s\S]*\S)?$

descriptionstring

labelsstring[]

Responses

200

Response for status 200

test_suite_idstring<uuid>required

namestringrequired

descriptionstring | nullrequired

Show properties

Any of:

string

string

null

null

labelsstring[]required

versionintegerrequired

Latest published; the draft is +1.

created_atstring<date-time>required

updated_atstring<date-time>required

404

Response for status 404

errorstringrequired

messagestring

codestring

detailsstring[]

409

Response for status 409

errorstringrequired

messagestring

codestring

detailsstring[]

422

Response for status 422

errorstringrequired

messagestring

codestring

detailsstring[]

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Personal API keyOrganization IDRemember on this deviceInclude my values in samples

Parameters

projectIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Organization-Id: YOUR_ORGANIZATION_ID' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "labels": [
    "string"
  ]
}'

const response = await fetch("https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "X-Organization-Id": "YOUR_ORGANIZATION_ID",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"labels\": [\n    \"string\"\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.judgmentlabs.ai/v1/projects/YOUR_PROJECT_ID/test-suites",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "X-Organization-Id": "YOUR_ORGANIZATION_ID",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"labels\": [\n    \"string\"\n  ]\n}",
)

Response

{
  "test_suite_id": "24b8f606-0469-466c-ae80-0678f89ae1bf",
  "name": "string",
  "description": "string",
  "labels": [
    "string"
  ],
  "version": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "message": "string",
  "code": "string",
  "details": [
    "string"
  ]
}

{
  "error": "string",
  "message": "string",
  "code": "string",
  "details": [
    "string"
  ]
}

{
  "error": "string",
  "message": "string",
  "code": "string",
  "details": [
    "string"
  ]
}