# Agents

## GET /api/v2/agents/{agent\_id}/files/root

> Read File Root

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/files/root":{"get":{"tags":["agents"],"summary":"Read File Root","operationId":"read_file_root_api_v2_agents__agent_id__files_root_get","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/{agent\_id}/files/{uid}

> Read File

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/files/{uid}":{"get":{"tags":["agents"],"summary":"Read File","operationId":"read_file_api_v2_agents__agent_id__files__uid__get","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentFile"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentFile":{"properties":{"id":{"type":"integer","title":"Id"},"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"path":{"type":"string","title":"Path"},"is_file":{"type":"boolean","title":"Is File"},"parent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"children":{"items":{"$ref":"#/components/schemas/AgentFile"},"type":"array","title":"Children","default":[]}},"type":"object","required":["id","session_id","name","path","is_file","downloads"],"title":"AgentFile"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/{uid}/tags

> Add Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/{uid}/tags":{"post":{"tags":["agents","tasks"],"summary":"Add Tag","operationId":"add_tag_api_v2_agents__agent_id__tasks__uid__tags_post","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TagRequest":{"properties":{"name":{"type":"string","pattern":"^[^:]+$","title":"Name"},"value":{"type":"string","pattern":"^[^:]+$","title":"Value"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["name","value"],"title":"TagRequest"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PUT /api/v2/agents/{agent\_id}/tasks/{uid}/tags/{tag\_id}

> Update Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id}":{"put":{"tags":["agents","tasks"],"summary":"Update Tag","operationId":"update_tag_api_v2_agents__agent_id__tasks__uid__tags__tag_id__put","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"tag_id","in":"path","required":true,"schema":{"type":"integer","title":"Tag Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TagRequest":{"properties":{"name":{"type":"string","pattern":"^[^:]+$","title":"Name"},"value":{"type":"string","pattern":"^[^:]+$","title":"Value"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["name","value"],"title":"TagRequest"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /api/v2/agents/{agent\_id}/tasks/{uid}/tags/{tag\_id}

> Delete Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/{uid}/tags/{tag_id}":{"delete":{"tags":["agents","tasks"],"summary":"Delete Tag","operationId":"delete_tag_api_v2_agents__agent_id__tasks__uid__tags__tag_id__delete","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"tag_id","in":"path","required":true,"schema":{"type":"integer","title":"Tag Id"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/tasks

> Read Tasks All Agents

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/tasks":{"get":{"tags":["agents","tasks"],"summary":"Read Tasks All Agents","operationId":"read_tasks_all_agents_api_v2_agents_tasks_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":-1,"title":"Limit"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"include_full_input","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Full Input"}},{"name":"include_original_output","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Original Output"}},{"name":"include_output","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Output"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AgentTaskOrderOptions","default":"id"}},{"name":"order_direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderDirection","default":"desc"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AgentTaskStatus"},{"type":"null"}],"title":"Status"}},{"name":"agents","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Agents"}},{"name":"users","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}],"title":"Users"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^[^:]+:[^:]+$"}},{"type":"null"}],"title":"Tags"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTasks"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentTaskOrderOptions":{"type":"string","enum":["id","updated_at","status","agent"],"title":"AgentTaskOrderOptions"},"OrderDirection":{"type":"string","enum":["asc","desc"],"title":"OrderDirection"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"AgentTasks":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentTask"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentTasks"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/{agent\_id}/tasks

> Read Tasks

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks":{"get":{"tags":["agents","tasks"],"summary":"Read Tasks","operationId":"read_tasks_api_v2_agents__agent_id__tasks_get","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":-1,"title":"Limit"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"include_full_input","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Full Input"}},{"name":"include_original_output","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Original Output"}},{"name":"include_output","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Output"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Since"}},{"name":"order_by","in":"query","required":false,"schema":{"$ref":"#/components/schemas/AgentTaskOrderOptions","default":"id"}},{"name":"order_direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderDirection","default":"desc"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AgentTaskStatus"},{"type":"null"}],"title":"Status"}},{"name":"users","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"integer"}},{"type":"null"}],"title":"Users"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^[^:]+:[^:]+$"}},{"type":"null"}],"title":"Tags"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTasks"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentTaskOrderOptions":{"type":"string","enum":["id","updated_at","status","agent"],"title":"AgentTaskOrderOptions"},"OrderDirection":{"type":"string","enum":["asc","desc"],"title":"OrderDirection"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"AgentTasks":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentTask"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentTasks"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/{agent\_id}/tasks/{uid}

> Read Task

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/{uid}":{"get":{"tags":["agents","tasks"],"summary":"Read Task","operationId":"read_task_api_v2_agents__agent_id__tasks__uid__get","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /api/v2/agents/{agent\_id}/tasks/{uid}

> Delete Task

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/{uid}":{"delete":{"tags":["agents","tasks"],"summary":"Delete Task","operationId":"delete_task_api_v2_agents__agent_id__tasks__uid__delete","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"integer","title":"Uid"}},{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/jobs

> Create Task Jobs

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/jobs":{"post":{"tags":["agents","tasks"],"summary":"Create Task Jobs","operationId":"create_task_jobs_api_v2_agents__agent_id__tasks_jobs_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/kill\_job

> Create Task Kill Job

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/kill_job":{"post":{"tags":["agents","tasks"],"summary":"Create Task Kill Job","operationId":"create_task_kill_job_api_v2_agents__agent_id__tasks_kill_job_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KillJobPostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"KillJobPostRequest":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"KillJobPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/stop\_job

> Create Task Stop Job

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/stop_job":{"post":{"tags":["agents","tasks"],"summary":"Create Task Stop Job","operationId":"create_task_stop_job_api_v2_agents__agent_id__tasks_stop_job_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopJobPostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"StopJobPostRequest":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"StopJobPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## Create Task Shell

> Executes a command on the agent. If literal is true, it will ignore the built-in aliases\
> such a whoami or ps and execute the command directly.

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/shell":{"post":{"tags":["agents","tasks"],"summary":"Create Task Shell","description":"Executes a command on the agent. If literal is true, it will ignore the built-in aliases\nsuch a whoami or ps and execute the command directly.","operationId":"create_task_shell_api_v2_agents__agent_id__tasks_shell_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShellPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ShellPostRequest":{"properties":{"command":{"type":"string","title":"Command"},"literal":{"type":"boolean","title":"Literal","default":false}},"type":"object","required":["command"],"title":"ShellPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/module

> Create Task Module

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/module":{"post":{"tags":["agents","tasks"],"summary":"Create Task Module","operationId":"create_task_module_api_v2_agents__agent_id__tasks_module_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulePostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ModulePostRequest":{"properties":{"module_id":{"type":"string","title":"Module Id"},"ignore_language_version_check":{"type":"boolean","title":"Ignore Language Version Check","default":false},"ignore_admin_check":{"type":"boolean","title":"Ignore Admin Check","default":false},"options":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Options"},"modified_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modified Input"}},"type":"object","required":["module_id","options"],"title":"ModulePostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/upload

> Create Task Upload

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/upload":{"post":{"tags":["agents","tasks"],"summary":"Create Task Upload","operationId":"create_task_upload_api_v2_agents__agent_id__tasks_upload_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"UploadPostRequest":{"properties":{"path_to_file":{"type":"string","title":"Path To File"},"file_id":{"type":"integer","title":"File Id"}},"type":"object","required":["path_to_file","file_id"],"title":"UploadPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/download

> Create Task Download

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/download":{"post":{"tags":["agents","tasks"],"summary":"Create Task Download","operationId":"create_task_download_api_v2_agents__agent_id__tasks_download_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DownloadPostRequest":{"properties":{"path_to_file":{"type":"string","title":"Path To File"}},"type":"object","required":["path_to_file"],"title":"DownloadPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/sysinfo

> Create Task Sysinfo

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/sysinfo":{"post":{"tags":["agents","tasks"],"summary":"Create Task Sysinfo","operationId":"create_task_sysinfo_api_v2_agents__agent_id__tasks_sysinfo_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SysinfoPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SysinfoPostRequest":{"properties":{},"type":"object","title":"SysinfoPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/update\_comms

> Create Task Update Comms

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/update_comms":{"post":{"tags":["agents","tasks"],"summary":"Create Task Update Comms","operationId":"create_task_update_comms_api_v2_agents__agent_id__tasks_update_comms_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommsPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CommsPostRequest":{"properties":{"new_listener_id":{"type":"integer","title":"New Listener Id"}},"type":"object","required":["new_listener_id"],"title":"CommsPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/sleep

> Create Task Update Sleep

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/sleep":{"post":{"tags":["agents","tasks"],"summary":"Create Task Update Sleep","operationId":"create_task_update_sleep_api_v2_agents__agent_id__tasks_sleep_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SleepPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SleepPostRequest":{"properties":{"delay":{"type":"integer","minimum":0,"title":"Delay"},"jitter":{"type":"number","maximum":1,"minimum":0,"title":"Jitter"}},"type":"object","required":["delay","jitter"],"title":"SleepPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/kill\_date

> Create Task Update Kill Date

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/kill_date":{"post":{"tags":["agents","tasks"],"summary":"Create Task Update Kill Date","operationId":"create_task_update_kill_date_api_v2_agents__agent_id__tasks_kill_date_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KillDatePostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"KillDatePostRequest":{"properties":{"kill_date":{"type":"string","title":"Kill Date"}},"type":"object","required":["kill_date"],"title":"KillDatePostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/working\_hours

> Create Task Update Working Hours

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/working_hours":{"post":{"tags":["agents","tasks"],"summary":"Create Task Update Working Hours","operationId":"create_task_update_working_hours_api_v2_agents__agent_id__tasks_working_hours_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkingHoursPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"WorkingHoursPostRequest":{"properties":{"working_hours":{"type":"string","title":"Working Hours"}},"type":"object","required":["working_hours"],"title":"WorkingHoursPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/directory\_list

> Create Task Update Directory List

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/directory_list":{"post":{"tags":["agents","tasks"],"summary":"Create Task Update Directory List","operationId":"create_task_update_directory_list_api_v2_agents__agent_id__tasks_directory_list_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryListPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DirectoryListPostRequest":{"properties":{"path":{"type":"string","title":"Path"}},"type":"object","required":["path"],"title":"DirectoryListPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/exit

> Create Task Exit

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/exit":{"post":{"tags":["agents","tasks"],"summary":"Create Task Exit","operationId":"create_task_exit_api_v2_agents__agent_id__tasks_exit_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExitPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ExitPostRequest":{"properties":{},"type":"object","title":"ExitPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{agent\_id}/tasks/socks

> Create Task Socks

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{agent_id}/tasks/socks":{"post":{"tags":["agents","tasks"],"summary":"Create Task Socks","operationId":"create_task_socks_api_v2_agents__agent_id__tasks_socks_post","parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocksPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTask"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"SocksPostRequest":{"properties":{"port":{"type":"integer","title":"Port"}},"type":"object","required":["port"],"title":"SocksPostRequest"},"AgentTask":{"properties":{"id":{"type":"integer","title":"Id"},"input":{"type":"string","title":"Input"},"full_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Input"},"output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output"},"original_output":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Output"},"user_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"User Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"agent_id":{"type":"string","title":"Agent Id"},"downloads":{"items":{"$ref":"#/components/schemas/DownloadDescription"},"type":"array","title":"Downloads"},"module_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Module Name"},"module_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Module Options"},"task_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Name"},"status":{"$ref":"#/components/schemas/AgentTaskStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["id","input","agent_id","downloads","status","created_at","updated_at","tags"],"title":"AgentTask"},"DownloadDescription":{"properties":{"id":{"type":"integer","title":"Id"},"filename":{"type":"string","title":"Filename"},"link":{"type":"string","title":"Link"}},"type":"object","required":["id","filename","link"],"title":"DownloadDescription"},"AgentTaskStatus":{"type":"string","enum":["queued","pulled","completed","error","continuous"],"title":"AgentTaskStatus"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## POST /api/v2/agents/{uid}/tags

> Add Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}/tags":{"post":{"tags":["agents"],"summary":"Add Tag","operationId":"add_tag_api_v2_agents__uid__tags_post","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TagRequest":{"properties":{"name":{"type":"string","pattern":"^[^:]+$","title":"Name"},"value":{"type":"string","pattern":"^[^:]+$","title":"Value"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["name","value"],"title":"TagRequest"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PUT /api/v2/agents/{uid}/tags/{tag\_id}

> Update Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}/tags/{tag_id}":{"put":{"tags":["agents"],"summary":"Update Tag","operationId":"update_tag_api_v2_agents__uid__tags__tag_id__put","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}},{"name":"tag_id","in":"path","required":true,"schema":{"type":"integer","title":"Tag Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"TagRequest":{"properties":{"name":{"type":"string","pattern":"^[^:]+$","title":"Name"},"value":{"type":"string","pattern":"^[^:]+$","title":"Value"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["name","value"],"title":"TagRequest"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## DELETE /api/v2/agents/{uid}/tags/{tag\_id}

> Delete Tag

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}/tags/{tag_id}":{"delete":{"tags":["agents"],"summary":"Delete Tag","operationId":"delete_tag_api_v2_agents__uid__tags__tag_id__delete","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}},{"name":"tag_id","in":"path","required":true,"schema":{"type":"integer","title":"Tag Id"}}],"responses":{"204":{"description":"Successful Response"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/checkins

> Read Agent Checkins All

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/checkins":{"get":{"tags":["agents"],"summary":"Read Agent Checkins All","operationId":"read_agent_checkins_all_api_v2_agents_checkins_get","parameters":[{"name":"agents","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Agents"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":1000,"title":"Limit"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"}},{"name":"order_direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderDirection","default":"desc"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCheckIns"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"OrderDirection":{"type":"string","enum":["asc","desc"],"title":"OrderDirection"},"AgentCheckIns":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentCheckIn"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentCheckIns"},"AgentCheckIn":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["agent_id","checkin_time"],"title":"AgentCheckIn"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/checkins/aggregate

> Read Agent Checkins Aggregate

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/checkins/aggregate":{"get":{"tags":["agents"],"summary":"Read Agent Checkins Aggregate","operationId":"read_agent_checkins_aggregate_api_v2_agents_checkins_aggregate_get","parameters":[{"name":"agents","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Agents"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"}},{"name":"bucket_size","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/AggregateBucket"},{"type":"null"}],"default":"day","title":"Bucket Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCheckInsAggregate"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AggregateBucket":{"type":"string","enum":["second","minute","hour","day"],"title":"AggregateBucket"},"AgentCheckInsAggregate":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentCheckInAggregate"},"type":"array","title":"Records"},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"},"bucket_size":{"type":"string","title":"Bucket Size"}},"type":"object","required":["records","bucket_size"],"title":"AgentCheckInsAggregate"},"AgentCheckInAggregate":{"properties":{"count":{"type":"integer","title":"Count"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["count","checkin_time"],"title":"AgentCheckInAggregate"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/{uid}

> Read Agent

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}":{"get":{"tags":["agents"],"summary":"Read Agent","operationId":"read_agent_api_v2_agents__uid__get","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Agent":{"properties":{"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"listener":{"type":"string","title":"Listener"},"host_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Host Id"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hostname"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Version"},"delay":{"type":"integer","title":"Delay"},"jitter":{"type":"number","title":"Jitter"},"external_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Ip"},"internal_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Ip"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"high_integrity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Integrity"},"process_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Process Id"},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Name"},"os_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Details"},"nonce":{"type":"string","title":"Nonce"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"},"lastseen_time":{"type":"string","format":"date-time","title":"Lastseen Time"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"children":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Children"},"servers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servers"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"functions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functions"},"kill_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kill Date"},"working_hours":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Working Hours"},"lost_limit":{"type":"integer","title":"Lost Limit"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"archived":{"type":"boolean","title":"Archived"},"stale":{"type":"boolean","title":"Stale"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["session_id","name","listener","delay","jitter","nonce","checkin_time","lastseen_time","lost_limit","archived","stale","tags"],"title":"Agent"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## PUT /api/v2/agents/{uid}

> Update Agent

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}":{"put":{"tags":["agents"],"summary":"Update Agent","operationId":"update_agent_api_v2_agents__uid__put","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AgentUpdateRequest":{"properties":{"name":{"type":"string","title":"Name"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","required":["name"],"title":"AgentUpdateRequest"},"Agent":{"properties":{"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"listener":{"type":"string","title":"Listener"},"host_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Host Id"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hostname"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Version"},"delay":{"type":"integer","title":"Delay"},"jitter":{"type":"number","title":"Jitter"},"external_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Ip"},"internal_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Ip"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"high_integrity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Integrity"},"process_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Process Id"},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Name"},"os_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Details"},"nonce":{"type":"string","title":"Nonce"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"},"lastseen_time":{"type":"string","format":"date-time","title":"Lastseen Time"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"children":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Children"},"servers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servers"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"functions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functions"},"kill_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kill Date"},"working_hours":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Working Hours"},"lost_limit":{"type":"integer","title":"Lost Limit"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"archived":{"type":"boolean","title":"Archived"},"stale":{"type":"boolean","title":"Stale"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["session_id","name","listener","delay","jitter","nonce","checkin_time","lastseen_time","lost_limit","archived","stale","tags"],"title":"Agent"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents

> Read Agents

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents":{"get":{"tags":["agents"],"summary":"Read Agents","operationId":"read_agents_api_v2_agents_get","parameters":[{"name":"include_archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Archived"}},{"name":"include_stale","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Stale"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agents"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Agents":{"properties":{"records":{"items":{"$ref":"#/components/schemas/Agent"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"Agents"},"Agent":{"properties":{"session_id":{"type":"string","title":"Session Id"},"name":{"type":"string","title":"Name"},"listener":{"type":"string","title":"Listener"},"host_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Host Id"},"hostname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hostname"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"language_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language Version"},"delay":{"type":"integer","title":"Delay"},"jitter":{"type":"number","title":"Jitter"},"external_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Ip"},"internal_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Internal Ip"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"high_integrity":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"High Integrity"},"process_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Process Id"},"process_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Process Name"},"os_details":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Details"},"nonce":{"type":"string","title":"Nonce"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"},"lastseen_time":{"type":"string","format":"date-time","title":"Lastseen Time"},"parent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"},"children":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Children"},"servers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Servers"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"functions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Functions"},"kill_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kill Date"},"working_hours":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Working Hours"},"lost_limit":{"type":"integer","title":"Lost Limit"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"archived":{"type":"boolean","title":"Archived"},"stale":{"type":"boolean","title":"Stale"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags"}},"type":"object","required":["session_id","name","listener","delay","jitter","nonce","checkin_time","lastseen_time","lost_limit","archived","stale","tags"],"title":"Agent"},"Tag":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"},"label":{"type":"string","title":"Label"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color"}},"type":"object","required":["id","name","value","label"],"title":"Tag"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /api/v2/agents/{uid}/checkins

> Read Agent Checkins

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/agents/{uid}/checkins":{"get":{"tags":["agents"],"summary":"Read Agent Checkins","operationId":"read_agent_checkins_api_v2_agents__uid__checkins_get","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":-1,"title":"Limit"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Date"}},{"name":"order_direction","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OrderDirection","default":"desc"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCheckIns"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"OrderDirection":{"type":"string","enum":["asc","desc"],"title":"OrderDirection"},"AgentCheckIns":{"properties":{"records":{"items":{"$ref":"#/components/schemas/AgentCheckIn"},"type":"array","title":"Records"},"limit":{"type":"integer","title":"Limit"},"page":{"type":"integer","title":"Page"},"total_pages":{"type":"integer","title":"Total Pages"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["records","limit","page","total_pages","total"],"title":"AgentCheckIns"},"AgentCheckIn":{"properties":{"agent_id":{"type":"string","title":"Agent Id"},"checkin_time":{"type":"string","format":"date-time","title":"Checkin Time"}},"type":"object","required":["agent_id","checkin_time"],"title":"AgentCheckIn"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"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"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```


---

# 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://bc-security.gitbook.io/empire-wiki/restful-api/agents.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.