Skip to main content
POST
Create Problem

Authorizations

x-api-key
string
header
required

Body

application/json
jobDescription
string
required

Job description used to generate the problem

Minimum string length: 1
desiredTime
integer
default:45

Desired assessment duration in minutes. Must be between 30 and 60.

Required range: 30 <= x <= 60
problemTitle
string

Optional problem title

Minimum string length: 1
additionalNotes
string

Optional notes to guide problem creation

seniorityLevel
enum<string>

Optional experience level for the generated assessment. Valid values match the Ropes UI: junior, mid-level, senior, staff. When omitted, Ropes infers seniority from the job description.

Available options:
junior,
mid-level,
senior,
staff
supportedLocales
enum<string>[]

Optional assessment locales. Omit for English-only; pass ["en", "fr"] for bilingual.

Available options:
en,
fr
integrationSource
string

Integration source. Must be provided with externalId.

externalId
string

External ID from the integration source. Must be provided with integrationSource.

Minimum string length: 1
testMode
boolean

Creates a non-production test problem and sends lifecycle webhooks without generating a real assessment. Available only for approved API integrations.

Response

Successfully queued problem creation

success
boolean
required
problemId
string
error
string