Skip to main content
GET
Get specifications

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Query Parameters

ids
string[]

Filter by specification IDs

organizationIds
string[]

Filter by organization IDs

productIds
string[]

Filter by product IDs

types
string[]

Filter by specification types (CAPABILITY, INABILITY, POLICY)

testTypes
string[]

Filter by dataset types

metricIds
string[]

Filter by linked metric IDs

isCritical
boolean

Filter by criticality. true lists only critical specifications, false only the others.

name
string

Filter by specification name (partial match)

description
string

Filter by specification description (partial match)

fromCreatedAt
string<date-time>

Filter by creation date (from)

toCreatedAt
string<date-time>

Filter by creation date (to)

sort
string[]

Sort instructions (field and direction pairs)

limit
integer

Maximum number of results

offset
integer

Number of results to skip

Response

Specifications retrieved successfully

id
string
Example:

"spec_123"

productId
string
Example:

"prod_123"

userId
string | null
Example:

"user_123"

name
string
Example:

"Accurate query responses"

description
string
Example:

"Product must respond accurately to user queries"

type
enum<string>
Available options:
CAPABILITY,
INABILITY,
POLICY
Example:

"CAPABILITY"

testType
enum<string> | null

POLICY: the classified value. CAPABILITY: always SCENARIOS (auto-assigned). Null for INABILITY.

Available options:
QUALITY,
RED_TEAMING,
SCENARIOS
Example:

"QUALITY"

testVariant
string | null

Only applicable for POLICY specifications. QUALITY: rag, entity_extraction, summarization, classification, translation, correction, other. RED_TEAMING: data_leakage, financial_attacks, illegal_activities, misuse, toxicity, custom.

Example:

"rag"

useForTestAlignment
boolean
Example:

true

isCritical
boolean

Marks a specification whose failure is serious for the business. Defaults to false. Must not be true for INABILITY specifications.

Example:

false

metricIds
string[]
Example:
createdAt
string<date-time>
deletedAt
string<date-time> | null