file-search

Queue Evaluation

Queue an evaluation of an uploaded case set against one to eight named query configurations. Idempotency-Key is required: within 24 hours the same key with the same body returns the stored 201 body with status 200; the same key with a different body is 409 (IDEMPOTENCY_KEY_REUSE). Gold is resolved at accept time (document id, then unique basename); unresolved cases are error and never queried or billed. Each configs[] entry is the v3 query body minus query and is validated the same way. Each unit (one question under one config) is billed as one query, so whether it costs credits depends on the plan; only units that ran (scored, or timed out at the 30 s limit) are counted. Scoring, limits, billing and the NDJSON format are on the Evaluations guide.

post/v3/collections/{collection_name}/evals

Path parameters

collection_namestring required

Headers

Idempotency-Keystring nullable required

Caller-chosen key, 1 to 256 characters of A-Z a-z 0-9 . _ : / = + -, scoped to the organization for 24 hours.

Request body

environmentstring nullable

Echo-only label for the scorecard. Does not switch collections.

upload_idstring required

Response

Idempotent replay: the stored original 201 body (including the original eval_id), not live status. Poll Get Eval for progress.

collection_namestring required

completed_atstring nullable

created_atstring required

environmentstring nullable

error_codestring nullable

error_messagestring nullable

eval_idstring required

idempotency_keystring required

request_idstring required

scorecardsobject

started_atstring nullable

status'pending' | 'running' | 'completed' | 'completed_with_errors' | 'failed' required

updated_atstring required

upload_idstring required

Changes

Changed in 2 of the 13 revisions of this API.625

Sep 24, 202661a9364ad042624See the full diff
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 16, 2026e82391fa5b0b1See the full diff
- ○
  endpoint added
  endpoint-added

Full history