Rankings

Update Ranking

Update a ranking.

put/api/v1/rankings/{ranking_id}

Request

  • Base URL: https://app.aimrank.io (the document declares no server; this is the origin it was published from)
  • URL: https://app.aimrank.io/api/v1/rankings/{ranking_id}
  • Auth: API key in header X-API-Key

Path parameters

ranking_idstring required

Request body

namestring nullable
descriptionstring nullable
is_publicboolean nullable
visibilitystring nullable
categorystring nullable
comparison_promptstring nullable
ends_atstring date-time nullable
goalstring nullable
min_raters_per_pairinteger nullable
qualification_requiredboolean nullable
qualification_pass_thresholdnumber nullable
judge_modestring nullable
default_judge_modelstring nullable
vote_weightingstring nullable
settingsobject nullable

Response

Successful Response

idstring required
slugstring nullable
namestring required
descriptionstring nullable required
is_publicboolean required
visibilitystring
tenant_idstring nullable
categorystring nullable required
owner_idstring required
entity_countinteger required
vote_countinteger required
created_atstring date-time required
updated_atstring date-time required
user_rolestring nullable
media_typestring nullable
comparison_promptstring
vote_typestring
ends_atstring date-time nullable
goalstring nullable
min_raters_per_pairinteger
qualification_requiredboolean
qualification_pass_thresholdnumber
judge_modestring
default_judge_modelstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.