# Flow Config

## GET /flow-config/{flow\_id}

> Get Flow

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/flow-config/{flow_id}":{"get":{"tags":["Flow Config"],"summary":"Get Flow","operationId":"get_flow_flow_config__flow_id__get","parameters":[{"name":"flow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"FlowOut":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"name":{"type":"string","title":"Name"},"verification_type":{"$ref":"#/components/schemas/VerificationType"},"version":{"type":"integer","title":"Version"},"is_active":{"type":"boolean","title":"Is Active","default":true},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["client_id","name","verification_type","version","config","id","created_at","updated_at"],"title":"FlowOut"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"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 /flow-config/{flow\_id}

> Update Flow

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/flow-config/{flow_id}":{"put":{"tags":["Flow Config"],"summary":"Update Flow","operationId":"update_flow_flow_config__flow_id__put","parameters":[{"name":"flow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"FlowUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version"},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"}},"type":"object","title":"FlowUpdate"},"FlowOut":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"name":{"type":"string","title":"Name"},"verification_type":{"$ref":"#/components/schemas/VerificationType"},"version":{"type":"integer","title":"Version"},"is_active":{"type":"boolean","title":"Is Active","default":true},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["client_id","name","verification_type","version","config","id","created_at","updated_at"],"title":"FlowOut"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"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 /flow-config/{flow\_id}

> Delete Flow

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/flow-config/{flow_id}":{"delete":{"tags":["Flow Config"],"summary":"Delete Flow","operationId":"delete_flow_flow_config__flow_id__delete","parameters":[{"name":"flow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Flow Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## GET /flow-config

> List Flows

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/flow-config":{"get":{"tags":["Flow Config"],"summary":"List Flows","operationId":"list_flows_flow_config_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"default":20,"title":"Size"}},{"name":"client_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Client Id"}},{"name":"verification_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verification Type"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"business_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Type"}},{"name":"customer_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedFlowOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"PaginatedFlowOut":{"properties":{"total":{"type":"integer","title":"Total"},"page":{"type":"integer","title":"Page"},"size":{"type":"integer","title":"Size"},"items":{"items":{"$ref":"#/components/schemas/FlowOut"},"type":"array","title":"Items"}},"type":"object","required":["total","page","size","items"],"title":"PaginatedFlowOut"},"FlowOut":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"name":{"type":"string","title":"Name"},"verification_type":{"$ref":"#/components/schemas/VerificationType"},"version":{"type":"integer","title":"Version"},"is_active":{"type":"boolean","title":"Is Active","default":true},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["client_id","name","verification_type","version","config","id","created_at","updated_at"],"title":"FlowOut"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"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 /flow-config

> Create Flow

```json
{"openapi":"3.1.0","info":{"title":"BeetleLabs","version":"1.0.0"},"servers":[{"url":"https://beetlelabs.ai/beetlelabs-verification","description":"Local development server"}],"paths":{"/flow-config":{"post":{"tags":["Flow Config"],"summary":"Create Flow","operationId":"create_flow_flow_config_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlowOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"FlowCreate":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"name":{"type":"string","title":"Name"},"verification_type":{"$ref":"#/components/schemas/VerificationType"},"version":{"type":"integer","title":"Version"},"is_active":{"type":"boolean","title":"Is Active","default":true},"config":{"additionalProperties":true,"type":"object","title":"Config"}},"type":"object","required":["client_id","name","verification_type","version","config"],"title":"FlowCreate"},"VerificationType":{"type":"string","enum":["INDIVIDUAL","BUSINESS","INDIVIDUAL_BUSINESS"],"title":"VerificationType"},"FlowOut":{"properties":{"client_id":{"type":"integer","title":"Client Id"},"name":{"type":"string","title":"Name"},"verification_type":{"$ref":"#/components/schemas/VerificationType"},"version":{"type":"integer","title":"Version"},"is_active":{"type":"boolean","title":"Is Active","default":true},"config":{"additionalProperties":true,"type":"object","title":"Config"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["client_id","name","verification_type","version","config","id","created_at","updated_at"],"title":"FlowOut"},"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://docs.beetlelabs.ai/flow-config.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.