Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
evaluators

Retrieve Evaluator

Get, update, or delete an evaluator's draft version.

GET /api/evaluators/{evaluator_id}/ - Get draft version (is_read_only=False) PATCH /api/evaluators/{evaluator_id}/ - Update draft version DELETE /api/evaluators/{evaluator_id}/ - Delete ALL versions

Superadmin: Can READ any evaluator across all organizations via JWT. Cannot WRITE via JWT - must use API key for write operations. Regular users: Can only access evaluators in their organization.

NOTE: Queryset filters by is_read_only=False, ensuring unique lookup per evaluator_id. This allows DRF's standard get_object() to work without manual overrides. Delete removes ALL versions of the evaluator.

Defense-in-depth:

  • SuperAdminMixin: Queryset routing + JWT write protection + object-level ownership
get/api/evaluators/{evaluator_id}/

Path parameters

evaluator_idstring required

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Response

version_idstring
configurationsobject
categorical_choicesobject[]
score_configobject
passing_conditionsobject nullable
llm_configobject nullable
code_configobject nullable
projectstring nullable
is_publicboolean required
eval_classstring
idstring
versioninteger
is_read_onlyboolean
version_descriptionstring
evaluator_slugstring
namestring required
descriptionstring
created_atstring date-time required
updated_atstring date-time required
type'llm' | 'code' | 'human' | 'function' | 'human_numerical' | 'human_categorical' | 'human_boolean' | 'human_text' | 'custom'
  • llm - Llm
  • code - Code
  • human - Human
  • function - Function
  • human_numerical - Human Numerical
  • human_categorical - Human Categorical
  • human_boolean - Human Boolean
  • human_text - Human Text
  • custom - Custom
score_value_type'numerical' | 'boolean' | 'percentage' | 'single_select' | 'multi_select' | 'text' | 'json' | 'comment' | 'categorical'
  • numerical - Numerical
  • boolean - Boolean
  • percentage - Percentage
  • single_select - Single Select
  • multi_select - Multi Select
  • text - Text
  • json - Json
  • comment - Comment
  • categorical - Categorical
custom_required_fieldsstring[]
starredboolean