generated: '2026-10-14' method: generated source: openapi/byrd-apis-openapi.yml description: Recommended x-agentic-access execution contracts, classified heuristically from the OpenAPI. A governance starting point for exposing this API to AI agents — review and bind audience per deployment. See research/curity/agentic-governance/. summary: operations: 69 by_action_class: connected: 39 acting: 30 by_consequence: read: 39 write: 19 physical: 11 human_in_the_loop_required: 0 operations: - path: /v2/auth method: get operationId: authapiv2_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/b2b_config/{b2b_config_id} method: get operationId: b2bconfigapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/b2b_config_templates method: get operationId: b2bconfigtemplateapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/export/user/{user_id}/returns method: get operationId: returnsexportapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/export/user/{user_id}/shipments method: get operationId: shipmentexportapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/login method: post operationId: loginapiv2_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/refresh_token method: post operationId: refreshtokenapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/returns method: get operationId: returnshipmentlistapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/returns/{return_id} method: get operationId: returnshipmentdetailapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/users/{user_id} method: patch operationId: userapiv2_patch x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/dangerous-goods-limits method: get operationId: dangerousgoodsunitlimitsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/deliveries method: get operationId: deliveriesapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/deliveries method: post operationId: deliveriesapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/deliveries/{delivery_id} method: get operationId: deliveryapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/deliveries/{delivery_id} method: put operationId: deliveryapi_put x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/deliveries/{delivery_id} method: patch operationId: deliveryapi_patch x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/deliveries/{delivery_id} method: delete operationId: deliveryapi_delete x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/deliveries/{delivery_id}/lots method: get operationId: deliverylotsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/delivery-documents method: get operationId: deliverydocumentsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/delivery-documents method: post operationId: deliverydocumentsapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/delivery-documents/{document_id} method: patch operationId: deliverydocumentapi_patch x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/delivery-documents/{document_id} method: delete operationId: deliverydocumentapi_delete x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/delivery-items/{item_id} method: get operationId: deliveryitemapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/export/user/{user_id}/inventory method: get operationId: inventoryexportapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/lots method: get operationId: lotlistapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/lots method: post operationId: lotlistapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/lots/{lot_id} method: get operationId: lotdetailapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/lots/{lot_id} method: patch operationId: lotdetailapi_patch x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products method: get operationId: productsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products method: post operationId: productsapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{bundle_id}/bundles method: get operationId: bundlelistapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products/{bundle_id}/bundles method: post operationId: bundlelistapi_post x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{bundle_id}/bundles method: put operationId: bundlelistapi_put x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{bundle_id}/bundles/{ingredient_id} method: get operationId: bundledetailsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products/{bundle_id}/bundles/{ingredient_id} method: delete operationId: bundledetailsapi_delete x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{product_id} method: get operationId: productapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products/{product_id} method: put operationId: productapi_put x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{product_id} method: patch operationId: productapi_patch x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{product_id} method: delete operationId: productapi_delete x-agentic-access: action-class: acting consequence: write subject: required audience: null token: max-ttl: 900 escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v2/warehouse/products/{product_id}/serial-numbers method: get operationId: productserialnumbersapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products/{product_id}/stats method: get operationId: productstatsapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/products/{product_id}/stock-by-warehouse method: get operationId: productstockbywarehouseapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/user-warehouse-links method: get operationId: userwarehouselinksapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/warehouses method: get operationId: warehousesapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v2/warehouse/warehouses/{warehouse_id} method: get operationId: warehouseapi_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/deliveries/count method: get operationId: deliverylistcountapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/picks method: get operationId: picklistapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/returns/announce method: post operationId: returnshipmentannouncedapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/returns/{return_id}/documents method: post operationId: returnshipmentdocumentsapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments method: get operationId: shipmentlistapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments method: post operationId: shipmentlistapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/count method: get operationId: shipmentlistcountapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/recall method: post operationId: shipmentbatchrecallapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/release method: post operationId: shipmentbatchreleaseapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/report method: get operationId: shipmentreportapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id} method: get operationId: shipmentapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id} method: patch operationId: shipmentapiv3_patch x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/{shipment_id} method: delete operationId: shipmentapiv3_delete x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/{shipment_id}/documents method: get operationId: shipmentdocumentsbatchapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id}/documents method: post operationId: shipmentdocumentsbatchapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/{shipment_id}/documents/{document_id}/file method: get operationId: shipmentdocumentfileapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id}/picks method: get operationId: shipmentpicklistapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id}/recall method: post operationId: shipmentrecallapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/{shipment_id}/reservations method: get operationId: shipmentreservationlistapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id}/schedule-pickup method: post operationId: schedulepickupapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/shipments/{shipment_id}/units/{unit_id} method: get operationId: shipmentunitapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/shipments/{shipment_id}/validate-address method: post operationId: shipmentaddressvalidationapiv3_post x-agentic-access: action-class: acting consequence: physical subject: required audience: null token: max-ttl: 300 exchange: true purpose-required: true escalation: human-in-the-loop: conditional triggers: - abnormal - high-value audit: required - path: /v3/units method: get operationId: unitlistapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none - path: /v3/units/count method: get operationId: unitlistcountapiv3_get x-agentic-access: action-class: connected consequence: read subject: optional token: max-ttl: 3600 audit: none