API Reference

Create a screening into the workspace (v2)

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

This endpoint creates a new screening into the workspace.

Compared to v1, it accepts the level, isDisabilitiesAffirmative and isTalentPool fields and requires an expiresAt date.

expiresAt must be a future date within 180 days from now, UNLESS isTalentPool is true or a templateCode is provided — in which case it is optional.

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

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
enum
required

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

Allowed:
boolean

Determine whether the AI assesses language proficiency or not.

number
≥ 0

Maximum number of follow-up questions

string

Partner job ID

boolean

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

number

Number of open positions

location
object
string

Name of the ATS integration that created this screening

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.

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.

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.

number
required
120 to 600

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

string
enum

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

date-time

Expiration date of the screening. Optional. When provided, must be a future date within 180 days from now, UNLESS "isTalentPool" is true or a "templateCode" is provided.

boolean

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

string | null

Logto id of the person responsible for the affirmative vacancy

string | null

E-mail of the person responsible for the affirmative vacancy

boolean

Whether this vacancy counts towards the Lei 8.213 quota

boolean

Whether this screening feeds a talent pool

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.

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.

Updated 3 months ago

Did this page help you?
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 3 months ago

Did this page help you?