> For the complete documentation index, see [llms.txt](https://docs.lightningrod.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lightningrod.ai/api-reference/open-ai-compatible.md).

# Open AI Compatible

## POST /v1/files

> Upload File

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"Body_upload_file_files_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"purpose":{"type":"string","title":"Purpose"},"expires_after[anchor]":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expires After[Anchor]"},"expires_after[seconds]":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires After[Seconds]"}},"type":"object","required":["file","purpose"],"title":"Body_upload_file_files_post"},"FileObject":{"properties":{"id":{"type":"string","title":"Id"},"bytes":{"type":"integer","minimum":0,"title":"Bytes"},"created_at":{"type":"integer","title":"Created At"},"filename":{"type":"string","title":"Filename"},"object":{"type":"string","const":"file","title":"Object","default":"file"},"purpose":{"type":"string","enum":["batch","batch_output"],"title":"Purpose"},"status":{"type":"string","enum":["uploaded","processed","error"],"title":"Status","default":"processed"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details"}},"type":"object","required":["id","bytes","created_at","filename","purpose"],"title":"FileObject"},"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":{"/v1/files":{"post":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Upload File","operationId":"upload_file_files_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_file_files_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /v1/files/{file\_id}/content

> Retrieve File Content

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"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":{"/v1/files/{file_id}/content":{"get":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Retrieve File Content","operationId":"retrieve_file_content_files__file_id__content_get","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}}],"responses":{"200":{"description":"File content","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /v1/files/{file\_id}

> Retrieve File

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"FileObject":{"properties":{"id":{"type":"string","title":"Id"},"bytes":{"type":"integer","minimum":0,"title":"Bytes"},"created_at":{"type":"integer","title":"Created At"},"filename":{"type":"string","title":"Filename"},"object":{"type":"string","const":"file","title":"Object","default":"file"},"purpose":{"type":"string","enum":["batch","batch_output"],"title":"Purpose"},"status":{"type":"string","enum":["uploaded","processed","error"],"title":"Status","default":"processed"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"status_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status Details"}},"type":"object","required":["id","bytes","created_at","filename","purpose"],"title":"FileObject"},"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":{"/v1/files/{file_id}":{"get":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Retrieve File","operationId":"retrieve_file_files__file_id__get","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## DELETE /v1/files/{file\_id}

> Delete File

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"FileDeleted":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"file","title":"Object","default":"file"},"deleted":{"type":"boolean","const":true,"title":"Deleted","default":true}},"type":"object","required":["id"],"title":"FileDeleted"},"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":{"/v1/files/{file_id}":{"delete":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Delete File","operationId":"delete_file_files__file_id__delete","parameters":[{"name":"file_id","in":"path","required":true,"schema":{"type":"string","title":"File Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDeleted"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /v1/batches

> List Batches

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"BatchListResponse":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/BatchObject"},"type":"array","title":"Data"},"first_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Id"},"last_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Id"},"has_more":{"type":"boolean","title":"Has More"}},"type":"object","required":["data","has_more"],"title":"BatchListResponse"},"BatchObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"batch","title":"Object","default":"batch"},"endpoint":{"type":"string","const":"/v1/chat/completions","title":"Endpoint"},"errors":{"anyOf":[{"$ref":"#/components/schemas/BatchErrors"},{"type":"null"}]},"input_file_id":{"type":"string","title":"Input File Id"},"completion_window":{"type":"string","const":"24h","title":"Completion Window","default":"24h"},"status":{"type":"string","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"],"title":"Status"},"output_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output File Id"},"error_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error File Id"},"created_at":{"type":"integer","title":"Created At"},"in_progress_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress At"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"finalizing_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Finalizing At"},"completed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completed At"},"failed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed At"},"expired_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expired At"},"cancelling_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelling At"},"cancelled_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelled At"},"request_counts":{"$ref":"#/components/schemas/BatchRequestCounts"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"usage":{"anyOf":[{"$ref":"#/components/schemas/BatchUsage"},{"type":"null"}]}},"type":"object","required":["id","endpoint","input_file_id","status","created_at"],"title":"BatchObject"},"BatchErrors":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/BatchError"},"type":"array","title":"Data"}},"type":"object","title":"BatchErrors"},"BatchError":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"line":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"}},"type":"object","title":"BatchError"},"BatchRequestCounts":{"properties":{"total":{"type":"integer","minimum":0,"title":"Total","default":0},"completed":{"type":"integer","minimum":0,"title":"Completed","default":0},"failed":{"type":"integer","minimum":0,"title":"Failed","default":0}},"type":"object","title":"BatchRequestCounts"},"BatchUsage":{"properties":{"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens"},"input_tokens_details":{"$ref":"#/components/schemas/BatchInputTokensDetails"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens"},"output_tokens_details":{"$ref":"#/components/schemas/BatchOutputTokensDetails"},"total_tokens":{"type":"integer","minimum":0,"title":"Total Tokens"}},"type":"object","required":["input_tokens","output_tokens","total_tokens"],"title":"BatchUsage"},"BatchInputTokensDetails":{"properties":{"cached_tokens":{"type":"integer","minimum":0,"title":"Cached Tokens","default":0}},"type":"object","title":"BatchInputTokensDetails"},"BatchOutputTokensDetails":{"properties":{"reasoning_tokens":{"type":"integer","minimum":0,"title":"Reasoning Tokens","default":0}},"type":"object","title":"BatchOutputTokensDetails"},"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":{"/v1/batches":{"get":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"List Batches","operationId":"list_batches_batches_get","parameters":[{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /v1/batches

> Create Batch

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"BatchCreateRequest":{"properties":{"input_file_id":{"type":"string","minLength":1,"title":"Input File Id"},"endpoint":{"type":"string","const":"/v1/chat/completions","title":"Endpoint"},"completion_window":{"type":"string","const":"24h","title":"Completion Window"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"output_expires_after":{"anyOf":[{"$ref":"#/components/schemas/ExpirationPolicy"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["input_file_id","endpoint","completion_window"],"title":"BatchCreateRequest"},"ExpirationPolicy":{"properties":{"anchor":{"type":"string","const":"created_at","title":"Anchor"},"seconds":{"type":"integer","maximum":2592000,"minimum":3600,"title":"Seconds"}},"additionalProperties":false,"type":"object","required":["anchor","seconds"],"title":"ExpirationPolicy"},"BatchObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"batch","title":"Object","default":"batch"},"endpoint":{"type":"string","const":"/v1/chat/completions","title":"Endpoint"},"errors":{"anyOf":[{"$ref":"#/components/schemas/BatchErrors"},{"type":"null"}]},"input_file_id":{"type":"string","title":"Input File Id"},"completion_window":{"type":"string","const":"24h","title":"Completion Window","default":"24h"},"status":{"type":"string","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"],"title":"Status"},"output_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output File Id"},"error_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error File Id"},"created_at":{"type":"integer","title":"Created At"},"in_progress_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress At"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"finalizing_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Finalizing At"},"completed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completed At"},"failed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed At"},"expired_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expired At"},"cancelling_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelling At"},"cancelled_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelled At"},"request_counts":{"$ref":"#/components/schemas/BatchRequestCounts"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"usage":{"anyOf":[{"$ref":"#/components/schemas/BatchUsage"},{"type":"null"}]}},"type":"object","required":["id","endpoint","input_file_id","status","created_at"],"title":"BatchObject"},"BatchErrors":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/BatchError"},"type":"array","title":"Data"}},"type":"object","title":"BatchErrors"},"BatchError":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"line":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"}},"type":"object","title":"BatchError"},"BatchRequestCounts":{"properties":{"total":{"type":"integer","minimum":0,"title":"Total","default":0},"completed":{"type":"integer","minimum":0,"title":"Completed","default":0},"failed":{"type":"integer","minimum":0,"title":"Failed","default":0}},"type":"object","title":"BatchRequestCounts"},"BatchUsage":{"properties":{"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens"},"input_tokens_details":{"$ref":"#/components/schemas/BatchInputTokensDetails"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens"},"output_tokens_details":{"$ref":"#/components/schemas/BatchOutputTokensDetails"},"total_tokens":{"type":"integer","minimum":0,"title":"Total Tokens"}},"type":"object","required":["input_tokens","output_tokens","total_tokens"],"title":"BatchUsage"},"BatchInputTokensDetails":{"properties":{"cached_tokens":{"type":"integer","minimum":0,"title":"Cached Tokens","default":0}},"type":"object","title":"BatchInputTokensDetails"},"BatchOutputTokensDetails":{"properties":{"reasoning_tokens":{"type":"integer","minimum":0,"title":"Reasoning Tokens","default":0}},"type":"object","title":"BatchOutputTokensDetails"},"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":{"/v1/batches":{"post":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Create Batch","operationId":"create_batch_batches_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /v1/batches/{batch\_id}

> Retrieve Batch

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"BatchObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"batch","title":"Object","default":"batch"},"endpoint":{"type":"string","const":"/v1/chat/completions","title":"Endpoint"},"errors":{"anyOf":[{"$ref":"#/components/schemas/BatchErrors"},{"type":"null"}]},"input_file_id":{"type":"string","title":"Input File Id"},"completion_window":{"type":"string","const":"24h","title":"Completion Window","default":"24h"},"status":{"type":"string","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"],"title":"Status"},"output_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output File Id"},"error_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error File Id"},"created_at":{"type":"integer","title":"Created At"},"in_progress_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress At"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"finalizing_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Finalizing At"},"completed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completed At"},"failed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed At"},"expired_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expired At"},"cancelling_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelling At"},"cancelled_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelled At"},"request_counts":{"$ref":"#/components/schemas/BatchRequestCounts"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"usage":{"anyOf":[{"$ref":"#/components/schemas/BatchUsage"},{"type":"null"}]}},"type":"object","required":["id","endpoint","input_file_id","status","created_at"],"title":"BatchObject"},"BatchErrors":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/BatchError"},"type":"array","title":"Data"}},"type":"object","title":"BatchErrors"},"BatchError":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"line":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"}},"type":"object","title":"BatchError"},"BatchRequestCounts":{"properties":{"total":{"type":"integer","minimum":0,"title":"Total","default":0},"completed":{"type":"integer","minimum":0,"title":"Completed","default":0},"failed":{"type":"integer","minimum":0,"title":"Failed","default":0}},"type":"object","title":"BatchRequestCounts"},"BatchUsage":{"properties":{"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens"},"input_tokens_details":{"$ref":"#/components/schemas/BatchInputTokensDetails"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens"},"output_tokens_details":{"$ref":"#/components/schemas/BatchOutputTokensDetails"},"total_tokens":{"type":"integer","minimum":0,"title":"Total Tokens"}},"type":"object","required":["input_tokens","output_tokens","total_tokens"],"title":"BatchUsage"},"BatchInputTokensDetails":{"properties":{"cached_tokens":{"type":"integer","minimum":0,"title":"Cached Tokens","default":0}},"type":"object","title":"BatchInputTokensDetails"},"BatchOutputTokensDetails":{"properties":{"reasoning_tokens":{"type":"integer","minimum":0,"title":"Reasoning Tokens","default":0}},"type":"object","title":"BatchOutputTokensDetails"},"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":{"/v1/batches/{batch_id}":{"get":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Retrieve Batch","operationId":"retrieve_batch_batches__batch_id__get","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## POST /v1/batches/{batch\_id}/cancel

> Cancel Batch

```json
{"openapi":"3.1.0","info":{"title":"LightningRod API","version":"1.0.0"},"servers":[{"url":"https://api.lightningrod.ai"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Lightning Rod API key (`sk_…`) sent as a Bearer token. Obtain one via `POST /v1/mpp/topup` (agents) or the dashboard (humans)."}},"schemas":{"BatchObject":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","const":"batch","title":"Object","default":"batch"},"endpoint":{"type":"string","const":"/v1/chat/completions","title":"Endpoint"},"errors":{"anyOf":[{"$ref":"#/components/schemas/BatchErrors"},{"type":"null"}]},"input_file_id":{"type":"string","title":"Input File Id"},"completion_window":{"type":"string","const":"24h","title":"Completion Window","default":"24h"},"status":{"type":"string","enum":["validating","failed","in_progress","finalizing","completed","expired","cancelling","cancelled"],"title":"Status"},"output_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output File Id"},"error_file_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error File Id"},"created_at":{"type":"integer","title":"Created At"},"in_progress_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"In Progress At"},"expires_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expires At"},"finalizing_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Finalizing At"},"completed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completed At"},"failed_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Failed At"},"expired_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expired At"},"cancelling_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelling At"},"cancelled_at":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cancelled At"},"request_counts":{"$ref":"#/components/schemas/BatchRequestCounts"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"usage":{"anyOf":[{"$ref":"#/components/schemas/BatchUsage"},{"type":"null"}]}},"type":"object","required":["id","endpoint","input_file_id","status","created_at"],"title":"BatchObject"},"BatchErrors":{"properties":{"object":{"type":"string","const":"list","title":"Object","default":"list"},"data":{"items":{"$ref":"#/components/schemas/BatchError"},"type":"array","title":"Data"}},"type":"object","title":"BatchErrors"},"BatchError":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"line":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Line"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"}},"type":"object","title":"BatchError"},"BatchRequestCounts":{"properties":{"total":{"type":"integer","minimum":0,"title":"Total","default":0},"completed":{"type":"integer","minimum":0,"title":"Completed","default":0},"failed":{"type":"integer","minimum":0,"title":"Failed","default":0}},"type":"object","title":"BatchRequestCounts"},"BatchUsage":{"properties":{"input_tokens":{"type":"integer","minimum":0,"title":"Input Tokens"},"input_tokens_details":{"$ref":"#/components/schemas/BatchInputTokensDetails"},"output_tokens":{"type":"integer","minimum":0,"title":"Output Tokens"},"output_tokens_details":{"$ref":"#/components/schemas/BatchOutputTokensDetails"},"total_tokens":{"type":"integer","minimum":0,"title":"Total Tokens"}},"type":"object","required":["input_tokens","output_tokens","total_tokens"],"title":"BatchUsage"},"BatchInputTokensDetails":{"properties":{"cached_tokens":{"type":"integer","minimum":0,"title":"Cached Tokens","default":0}},"type":"object","title":"BatchInputTokensDetails"},"BatchOutputTokensDetails":{"properties":{"reasoning_tokens":{"type":"integer","minimum":0,"title":"Reasoning Tokens","default":0}},"type":"object","title":"BatchOutputTokensDetails"},"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":{"/v1/batches/{batch_id}/cancel":{"post":{"tags":["OpenAI Compatible","OpenAI Compatible"],"summary":"Cancel Batch","operationId":"cancel_batch_batches__batch_id__cancel_post","parameters":[{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```