Bot Controls API
Auto-generated from
openapi-snapshot.json. Do not edit by hand — changes are overwritten byscripts/docs/generate_api_reference.py.
9 endpoints in this group.
GET /api/bot-controls/agents
List Agent Policies
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id | query | — | optional | |
page | query | integer | optional | 1-based page index. |
page_size | query | integer | optional | Page size — must be one of 25, 50, 100. |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PATCH /api/bot-controls/agents/{agent_id}
Update Agent Policy
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | integer | required |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/bot-controls/agents/{agent_id}/limits
Get Bot Limits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | integer | required |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PUT /api/bot-controls/agents/{agent_id}/limits
Set Bot Limits
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | integer | required |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/bot-controls/agents/{agent_id}/usage
Get Bot Usage Today
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
agent_id | path | integer | required |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/bot-controls/approval-threshold
Get Approval Threshold
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id | query | — | optional |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PUT /api/bot-controls/approval-threshold
Set Approval Threshold
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id | query | — | optional |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
PUT /api/bot-controls/approval-threshold/account-override
Set Account Threshold Override
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenant_id | query | — | optional |
Request body: application/json
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |
GET /api/bot-controls/approval-threshold/preview
Preview Threshold Affected Orders
Recent orders whose notional would have exceeded the proposed threshold.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
proposed_threshold | query | number | required | |
tenant_id | query | — | optional | |
days | query | integer | optional |
Responses
| Code | Description |
|---|---|
200 | Successful Response |
422 | Validation Error |