API Reference

Create a screening into the workspace

post
https://api-screening.digai.ai/api/v1/public/workspaces//screenings

This endpoint creates a new screening into the workspace

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the workspace (UUID v4)

Body Params

Payload to create a new screening

string
required

Title of the job

string
required

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

string
required

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

boolean
required

Determine whether the AI assesses language proficiency or not.

number
required

Maximum number of follow-up questions

string
required

Partner job ID

boolean
required

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

number
required

Number of open positions

number
required

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.

number
required

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
required

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.

number
required

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

Responses

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.

Updated over 1 year ago

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago