Job Criteria
The criteria for a given Job by which to evaluate Candidates. Right now, only boolean (yes/no) criteria are supported; contact Endorsed to request additional types.
Create a Criterion
POST
https://endorsed.ai/api/v1/jobs/{id}/criteria
Creates a new Job Criterion and returns the Criterion's UUID.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Request Body
prompt_text*
string
display_name
string
The text to display in place of the prompt_text
when returning or displaying evaluations. If not set, prompt_text
will be used.
Examples:
Get all existing Criteria for the specified Job
GET
https://endorsed.ai/api/v1/jobs/{id}/criteria
Get all existing Criteria by a Job's UUID ID or by a remote ID. Remote IDs MUST be structured by remote.<id>.
Path Parameters
id*
string
UUID ID of the Job
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Examples:
Get a single existing Job Criterion
GET
https://endorsed.ai/api/v1/jobs/{id}/criteria/{id}
Retrieve a single existing Job Criterion given its ID and associated Job's ID. Job ID may be either Endorsed's UUIDs or your system's IDs structured like remote.<id>
.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Examples:
Delete a single existing Job Criterion
DELETE
https://endorsed.ai/api/v1/jobs/{id}/criteria/{id}
Delete a single existing Job Criterion given its ID and associated Job's ID. IDs may be either Endorsed's UUIDs or your system's IDs structured like remote.<id>
.
Headers
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens
endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json
. If not set, defaults to application/json
Last updated