Create a screening into the workspace (v2)

post

https://api-screening.digai.ai/api/v2/public/workspaces/{workspaceId}/screenings

This endpoint creates a new screening into the workspace.

Compared to v1, it accepts the level, isDisabilitiesAffirmative and isTalentPool fields.

The screening is created without an expiration date. expiresAt is deprecated: it is still accepted, but ignored.

Example Request:
POST /api/v2/public/workspaces/{workspaceId}/screenings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceId

string

required

Unique identifier of the workspace (UUID v4)

Body Params

Payload to create a new screening

title

string

required

Title of the job

description

string

required

Description of the job. The more details provided, the better the quality of the generated questions will be

language

string

enum

required

Language in which the questions will be generated and the candidate will answer

Allowed:

requireProficiencyTest

boolean

Determine whether the AI assesses language proficiency or not.

maxFollowUpQuestions

number

≥ 0

Maximum number of follow-up questions

partnerJobId

string

Partner job ID

allowReuse

boolean

Determine whether prior interviews are allowed to be reused to fulfill this screening

positionsToFill

number

Number of open positions

location

object

integratedWith

string

Name of the ATS integration that created this screening

templateCode

number

1000 to 9999

Template code (4-digit). When provided, screening is created from this template instead of generating from scratch. Used by Inhire integration.

allowedAttempts

number

required

≥ 1

Total number of attempts allowed for the candidate. These attempts apply to the entire interview process, not individual questions. The candidate must complete the entire interview before starting a new attempt.

questionNumber

number

required

1 to 10

Number of questions in the screening. The maximum number of questions that can be generated is 10. After that, no more questions can be generated for screening, even if some are archived.

questionTypeProportion

object

Proportion of technical and behavioral questions. The sum of the two proportions must be 100. The proportion of each type of question is used to generate the questions. If not provided, the default proportion is 50% for each type of question. If PULSE_CHECK is selected in the classification type, the proportion is not used.

timeToResponse

number

required

120 to 600

Time in seconds the candidate has to READ and respond to each question

createdByEmail

string

E-mail of the platform user who owns this screening, used as its creator. The API key identifies the company, not the person, so without this the screening is attributed to the account itself. Optional: when omitted, unknown, or not linked to the API key owner company, the screening falls back to being attributed to the account.

createdByFallbackEmail

string

Second candidate for the screening creator, tried only when createdByEmail is omitted, unknown, inactive, or not linked to the API key owner company. Subject to the same checks.

level

string

enum

Seniority level of the screening. Optional — defaults to NOT_REPORTED when omitted.

expiresAt

date-time

deprecated

Deprecated and ignored. Screenings created through the public API have no expiration date; any value sent here is discarded.

isDisabilitiesAffirmative

boolean

Whether this is an affirmative vacancy for people with disabilities (PCD)

affirmativeOwnerId

string | null

Logto id of the person responsible for the affirmative vacancy

affirmativeOwnerEmail

string | null

E-mail of the person responsible for the affirmative vacancy

countsForQuota8213

boolean

Whether this vacancy counts towards the Lei 8.213 quota

isTalentPool

boolean

Whether this screening feeds a talent pool

workModel

string

enum

Allowed:

Responses

201

400

Bad Request: Invalid or missing parameters.

401

Unauthorized: The token is invalid or expired.

403

Forbidden: The user does not have permission to access this resource.

404

Not Found: The specified workspace does not exist.

429

Too Many Requests: Rate limit exceeded.

200Successfully created the screening.