API Reference
Invoke an agent tool
Invokes one high-level Backwork tool through the controlled agent access layer. Use GET /agent/tools first to fetch the exact input schema for each tool.
Authorization
bearerAuth AuthorizationBearer <token>
API keys are prefixed with bwk_live_ for production or bwk_test_ for testing.
Example: bwk_live_abc123xyz
Keys issued before the current format carry the vrt_live_/vrt_test_ prefix. Both prefixes are accepted while integrations rotate.
In: header
Path Parameters
tool*string
Agent tool ID
Value in
"check_coverage" | "validate_claim" | "find_policies" | "check_updates" | "acknowledge_policy_change"Header Parameters
X-Backwork-Agent?string
Optional agent name recorded in the invocation ledger.
Length
length <= 120X-Backwork-Approval?string
Set to reviewed only after authorized review for tools that require approval.
Value in
"reviewed"Request Body
application/json
[key: string]?any
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://backworkhealth.com/api/v1/agent/tools/check_coverage" \ -H "Content-Type: application/json" \ -d '{}'{
"success": true,
"data": {},
"meta": {
"request_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"tool": "string",
"actor_type": "api_client",
"actor_name": "string",
"approval_status": "not_required"
}
}{
"success": true,
"data": {},
"meta": {
"request_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"tool": "string",
"actor_type": "api_client",
"actor_name": "string",
"approval_status": "not_required"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid query parameters",
"hint": "Check the 'code' parameter format",
"details": {}
},
"meta": {
"request_id": "req_abc123"
}
}Last updated on