# Evaluations

## List Eval Jobs

> List evaluation jobs

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"/api/public/v1"}],"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"EvalJobListResponse":{"properties":{"jobs":{"items":{"$ref":"#/components/schemas/EvalJob"},"type":"array","title":"Jobs"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["jobs","total_count"],"title":"EvalJobListResponse"},"EvalJob":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"config":{"$ref":"#/components/schemas/EvalConfig"},"cost_dollars":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Dollars"},"current_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Step"},"total_steps":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Steps"},"status":{"$ref":"#/components/schemas/EvalJobStatus"},"metrics":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metrics"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","config","status","created_at","updated_at"],"title":"EvalJob"},"EvalConfig":{"properties":{"organization_id":{"type":"string","title":"Organization Id"},"model_id":{"type":"string","title":"Model Id"},"dataset":{"$ref":"#/components/schemas/SampleDatasetConfig"},"benchmark_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark Model Id"},"temperature":{"type":"number","title":"Temperature","default":0},"max_tokens":{"type":"integer","title":"Max Tokens","default":8192},"max_concurrent":{"type":"integer","title":"Max Concurrent","default":50}},"type":"object","required":["organization_id","model_id","dataset"],"title":"EvalConfig"},"SampleDatasetConfig":{"properties":{"id":{"type":"string","title":"Id"},"sample_ids":{"items":{"type":"string"},"type":"array","title":"Sample Ids"},"prompt_template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Template"}},"type":"object","required":["id","sample_ids"],"title":"SampleDatasetConfig"},"EvalJobStatus":{"type":"string","enum":["STARTING","RUNNING","COMPLETED","FAILED"],"title":"EvalJobStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/evaluations":{"get":{"tags":["Evaluations"],"summary":"List Eval Jobs","description":"List evaluation jobs","operationId":"list_eval_jobs_evaluations_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalJobListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Create Eval Job

> Create a new evaluation job

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"/api/public/v1"}],"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"CreateEvalJobRequest":{"properties":{"dataset":{"$ref":"#/components/schemas/SampleDatasetConfig"},"model_id":{"type":"string","title":"Model Id"},"benchmark_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark Model Id"},"temperature":{"type":"number","title":"Temperature","default":0}},"type":"object","required":["dataset","model_id"],"title":"CreateEvalJobRequest"},"SampleDatasetConfig":{"properties":{"id":{"type":"string","title":"Id"},"sample_ids":{"items":{"type":"string"},"type":"array","title":"Sample Ids"},"prompt_template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Template"}},"type":"object","required":["id","sample_ids"],"title":"SampleDatasetConfig"},"EvalJob":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"config":{"$ref":"#/components/schemas/EvalConfig"},"cost_dollars":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Dollars"},"current_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Step"},"total_steps":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Steps"},"status":{"$ref":"#/components/schemas/EvalJobStatus"},"metrics":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metrics"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","config","status","created_at","updated_at"],"title":"EvalJob"},"EvalConfig":{"properties":{"organization_id":{"type":"string","title":"Organization Id"},"model_id":{"type":"string","title":"Model Id"},"dataset":{"$ref":"#/components/schemas/SampleDatasetConfig"},"benchmark_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark Model Id"},"temperature":{"type":"number","title":"Temperature","default":0},"max_tokens":{"type":"integer","title":"Max Tokens","default":8192},"max_concurrent":{"type":"integer","title":"Max Concurrent","default":50}},"type":"object","required":["organization_id","model_id","dataset"],"title":"EvalConfig"},"EvalJobStatus":{"type":"string","enum":["STARTING","RUNNING","COMPLETED","FAILED"],"title":"EvalJobStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/evaluations":{"post":{"tags":["Evaluations"],"summary":"Create Eval Job","description":"Create a new evaluation job","operationId":"create_eval_job_evaluations_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvalJobRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Get Eval Job

> Get an evaluation job by ID

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"/api/public/v1"}],"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"EvalJob":{"properties":{"id":{"type":"string","title":"Id"},"organization_id":{"type":"string","title":"Organization Id"},"config":{"$ref":"#/components/schemas/EvalConfig"},"cost_dollars":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Cost Dollars"},"current_step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Current Step"},"total_steps":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Steps"},"status":{"$ref":"#/components/schemas/EvalJobStatus"},"metrics":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metrics"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","organization_id","config","status","created_at","updated_at"],"title":"EvalJob"},"EvalConfig":{"properties":{"organization_id":{"type":"string","title":"Organization Id"},"model_id":{"type":"string","title":"Model Id"},"dataset":{"$ref":"#/components/schemas/SampleDatasetConfig"},"benchmark_model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark Model Id"},"temperature":{"type":"number","title":"Temperature","default":0},"max_tokens":{"type":"integer","title":"Max Tokens","default":8192},"max_concurrent":{"type":"integer","title":"Max Concurrent","default":50}},"type":"object","required":["organization_id","model_id","dataset"],"title":"EvalConfig"},"SampleDatasetConfig":{"properties":{"id":{"type":"string","title":"Id"},"sample_ids":{"items":{"type":"string"},"type":"array","title":"Sample Ids"},"prompt_template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Template"}},"type":"object","required":["id","sample_ids"],"title":"SampleDatasetConfig"},"EvalJobStatus":{"type":"string","enum":["STARTING","RUNNING","COMPLETED","FAILED"],"title":"EvalJobStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/evaluations/{eval_id}":{"get":{"tags":["Evaluations"],"summary":"Get Eval Job","description":"Get an evaluation job by ID","operationId":"get_eval_job_evaluations__eval_id__get","parameters":[{"name":"eval_id","in":"path","required":true,"schema":{"type":"string","title":"Eval Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvalJob"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.lightningrod.ai/rest-api/evaluations.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.