{ "item": [ { "name": "System", "description": "Service status and the API description.", "item": [ { "id": "172febcb-153c-4b42-857c-8be7001164fe", "name": "Service health", "request": { "name": "Service health", "description": {}, "url": { "path": [ "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "512fb097-380f-43d1-a2f1-40d47ca72f5a", "name": "The API is up.", "originalRequest": { "url": { "path": [ "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"version\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "501f7015-6dde-4be3-8184-987a71fd4e53", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Conversations", "description": "A conversation between VERA and one person on your platform.", "item": [ { "id": "199a4605-dc0b-4931-8004-f347486eaa8a", "name": "Start a conversation", "request": { "name": "Start a conversation", "description": { "content": "Starts a conversation between VERA and one person on your platform.\n`end_user_id` must be an opaque ID from your system, never a name, email address or phone number.\nSet `country` so VERA gives the right crisis numbers.\n", "type": "text/plain" }, "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "a2c82c34-090a-4adf-aef2-9e0f475f5481", "name": "Created.", "originalRequest": { "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"conversation\"\n },\n \"end_user_id\": \"\",\n \"locale\": \"\",\n \"country\": \"\",\n \"metadata\": {\n \"minim_a\": \"\"\n },\n \"safety_hold\": \"\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "071e5b47-efed-4d0f-8056-430ea5251e88", "name": "The request is not valid.", "originalRequest": { "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d89d018-0f08-4fa6-9c7a-e8dae681607c", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1fe9e9e-4fba-4387-90a8-aee2b9cabc19", "name": "The key lacks a scope, or the person does not match.", "originalRequest": { "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e5fceaa-a3a6-4d4c-95ae-ced4b94b3646", "name": "Too many requests. See Retry-After.", "originalRequest": { "url": { "path": [ "v1", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"8O\",\n \"locale\": \"en\",\n \"country\": \"KC\",\n \"metadata\": {\n \"laborum_aef\": \"\",\n \"reprehenderit_92\": \"\",\n \"proident___d\": \"\",\n \"amet_\": \"\",\n \"sunt9\": \"\",\n \"dolor_4ad\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2869a5be-b4c1-4592-aabf-e0e0b0cf209c", "name": "Get a conversation", "request": { "name": "Get a conversation", "description": {}, "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "12be41e8-fe00-479d-956e-d57cbf444e45", "name": "The conversation.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"conversation\"\n },\n \"end_user_id\": \"\",\n \"locale\": \"\",\n \"country\": \"\",\n \"metadata\": {\n \"minim_a\": \"\"\n },\n \"safety_hold\": \"\",\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5b8a265-5587-48bd-9117-5c0c6c7ca57d", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7bc10d05-aec0-44c2-9074-ba8434f01416", "name": "Delete a conversation", "request": { "name": "Delete a conversation", "description": { "content": "Permanently deletes the conversation, its messages and its actions. Use this when a person asks for their data to be deleted.", "type": "text/plain" }, "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "id": "003277ce-d75b-44be-b583-8a995a431e0f", "name": "Deleted.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "39b5d5c6-03f1-4349-b10d-21f7319b7b50", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Messages", "description": "Talk with VERA. Every reply carries a safety assessment.", "item": [ { "id": "114bab2c-4d4b-4f40-83e4-a2bc681c60e5", "name": "Send a message to VERA", "request": { "name": "Send a message to VERA", "description": { "content": "Sends the person's message and returns VERA's reply.\n\nAlways check `safety` in the response:\n- `crisis`: show `message.content` and **all** `safety.resources` prominently. `display_required` is true. Do not hide, shorten or delay them.\n- `elevated`: the conversation is in a safety hold. Actions are paused; show the resources where practical.\n- `none`: normal reply.\n\n`proposed_actions` lists actions VERA suggests. Nothing happens until the person approves one.\n", "type": "text/plain" }, "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "b5504daa-9509-4881-9803-2b5b5065bdea", "name": "VERA's reply.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"vera.reply\"\n },\n \"conversation_id\": \"\",\n \"message\": {\n \"id\": \"\",\n \"role\": {\n \"const\": \"assistant\"\n },\n \"content\": \"\",\n \"created_at\": \"\"\n },\n \"safety\": {\n \"level\": \"crisis\",\n \"protocol\": \"\",\n \"display_required\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"contact\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"contact\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"proposed_actions\": [\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"approved\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"approved\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c202cf5-193a-44f8-b3d5-42139fb4d244", "name": "The request is not valid.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a885c1ad-e150-4964-9df2-dbdfbe0b360e", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d5be6ac-d836-42c2-adf2-35b8c0aa3ce9", "name": "Too many requests. See Retry-After.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76d99770-30b1-4b6f-a7c8-e4f4deb128f8", "name": "VERA is temporarily unavailable. Retry with the same Idempotency-Key.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0701462b-52d0-4ff9-8d76-cdf43f2719f5", "name": "List messages", "request": { "name": "List messages", "description": {}, "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "3c1a4168-f8b6-4f4b-b5f3-bfb0ae1fc378", "name": "Messages, oldest first.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"message\"\n },\n \"role\": \"assistant\",\n \"content\": \"\",\n \"safety_level\": \"elevated\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"message\"\n },\n \"role\": \"user\",\n \"content\": \"\",\n \"safety_level\": \"elevated\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a6f0939-47c7-4931-bdb9-af43761aff87", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Actions", "description": "Proposals from VERA that only happen after the person approves.", "item": [ { "id": "a76f18f9-b432-4d89-a54b-9255b2336dd8", "name": "List a conversation's actions", "request": { "name": "List a conversation's actions", "description": {}, "url": { "path": [ "v1", "conversations", ":conversation_id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "e175889b-44ed-4acd-8397-482fea0c1b4b", "name": "Actions.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"rejected\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": {},\n \"completed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"failed\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e76b3551-13b1-4536-8b56-798b57c6df78", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "conversations", ":conversation_id", "actions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ea2b2ca-0ac0-4a7c-9886-9c2f0eeb4b40", "name": "Get an action", "request": { "name": "Get an action", "description": {}, "url": { "path": [ "v1", "actions", ":action_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "action_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "02c00570-4ebe-4011-94b7-53e5bc763af1", "name": "The action.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"rejected\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b90de7-1817-4584-9ef8-62008c8df564", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a863fab9-9bb1-414a-913f-95b7bc425c9f", "name": "Record the person's approval", "request": { "name": "Record the person's approval", "description": { "content": "Call this only after the person has seen the action's summary in your interface and explicitly approved it.\n`end_user_id` must match the conversation's person. Actions expire after 24 hours.\nAfter approval, your platform carries out the action, then reports the outcome with `/result`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "actions", ":action_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "action_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "8becb8b0-56e8-4d51-ae1b-a5501a2284e1", "name": "Approved.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"rejected\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffbd50ce-8bc5-424b-b215-e02de045b1ef", "name": "The key lacks a scope, or the person does not match.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40a2a89c-886c-4153-9027-5067a87c6e47", "name": "The action is not in a state that allows this.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "approve" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "165bfe92-4e54-4722-894a-e9bfe7842899", "name": "Record the person's rejection", "request": { "name": "Record the person's rejection", "description": {}, "url": { "path": [ "v1", "actions", ":action_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "action_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "fe1d03e2-7252-4641-8495-ae4d2b72f4e3", "name": "Rejected.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"rejected\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c544cfe7-9e3d-4905-af61-e75cad152739", "name": "The key lacks a scope, or the person does not match.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e589287-b368-4f60-b54a-db6e8a24005a", "name": "The action is not in a state that allows this.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "reject" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"end_user_id\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e96f7157-7aea-496c-b243-aa15487b3445", "name": "Report what happened", "request": { "name": "Report what happened", "description": { "content": "Tell VERA whether an approved action succeeded. VERA sees this on the next turn, so it never claims something happened that didn't.", "type": "text/plain" }, "url": { "path": [ "v1", "actions", ":action_id", "result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "action_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"output\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "75f871bc-13c7-4450-879d-ac5b05df0f58", "name": "Recorded.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"output\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"action\"\n },\n \"conversation_id\": \"\",\n \"tool\": \"\",\n \"arguments\": {},\n \"summary\": \"\",\n \"status\": \"rejected\",\n \"proposed_at\": \"\",\n \"expires_at\": \"\",\n \"decided_at\": \"\",\n \"decided_by\": \"\",\n \"decision_note\": \"\",\n \"result\": null,\n \"completed_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7af957f-00af-4135-babc-04a048556ba1", "name": "The action is not in a state that allows this.", "originalRequest": { "url": { "path": [ "v1", "actions", ":action_id", "result" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Retry safely. The same key within 24 hours returns the original response instead of processing twice.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"output\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tools", "description": "The actions VERA may propose on your platform.", "item": [ { "id": "d1e3722f-4b5d-4d24-9b26-006ef5909941", "name": "List your tools", "request": { "name": "List your tools", "description": {}, "url": { "path": [ "v1", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "d238bf47-83b5-4493-8750-8c5ce43b6f88", "name": "Tools.", "originalRequest": { "url": { "path": [ "v1", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"object\": {\n \"const\": \"tool\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"input_schema\": {},\n \"created_at\": \"\"\n },\n {\n \"object\": {\n \"const\": \"tool\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"input_schema\": {},\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab624534-a5e6-4d36-aac2-d5fa7ac957a3", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "tools" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd559557-b4d7-408a-9cdf-7cfe4679ff0d", "name": "Register or update a tool", "request": { "name": "Register or update a tool", "description": { "content": "Declares an action VERA may *propose* on your platform, such as `schedule_meeting` or `create_invoice_draft`.\nVERA never executes tools. Your platform does, after the person approves.\nArguments VERA proposes are checked against `input_schema`; invalid proposals are discarded.\n", "type": "text/plain" }, "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "f8rn0l2rhiykod5odp67j99wrdahwl_do", "key": "name", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"input_schema\": {\n \"type\": {\n \"const\": \"object\"\n },\n \"properties\": {\n \"incididunt82\": {\n \"type\": \"number\",\n \"description\": \"\",\n \"enum\": \"\"\n }\n },\n \"required\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "ec045459-e20f-4862-9718-acb2c4d6f49e", "name": "Saved.", "originalRequest": { "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"input_schema\": {\n \"type\": {\n \"const\": \"object\"\n },\n \"properties\": {\n \"incididunt82\": {\n \"type\": \"number\",\n \"description\": \"\",\n \"enum\": \"\"\n }\n },\n \"required\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"tool\"\n },\n \"name\": \"\",\n \"description\": \"\",\n \"input_schema\": {},\n \"created_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9a7087f-1cf2-40b1-bb99-b99ff12a5b87", "name": "The request is not valid.", "originalRequest": { "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"input_schema\": {\n \"type\": {\n \"const\": \"object\"\n },\n \"properties\": {\n \"incididunt82\": {\n \"type\": \"number\",\n \"description\": \"\",\n \"enum\": \"\"\n }\n },\n \"required\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da4c014d-c9bf-41fc-95fc-159660b5b531", "name": "Remove a tool", "request": { "name": "Remove a tool", "description": {}, "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "f8rn0l2rhiykod5odp67j99wrdahwl_do", "key": "name", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "id": "78ad1d37-2108-4c14-856b-109ad94497b8", "name": "Removed.", "originalRequest": { "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08389896-2436-47e4-ad53-a2808d1ce2ff", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "tools", ":name" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Webhooks", "description": "Signed notifications about actions and safety events.", "item": [ { "id": "84b2aa4e-d6cc-4409-a864-cf3317149a8f", "name": "Add a webhook endpoint", "request": { "name": "Add a webhook endpoint", "description": { "content": "Receive signed events. The `secret` is returned only once.\nEach delivery has `VERA-Signature: t=,v1=`, where v1 = HMAC-SHA256(secret, \".\").\nVerify it, and reject timestamps older than 5 minutes.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"action.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "response": [ { "id": "e5e3f606-f810-4ace-9aca-53517e3788c3", "name": "Created. Store the secret now.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"action.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"object\": {\n \"const\": \"webhook_endpoint\"\n },\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a33220ad-38fa-41e6-aa40-66fe302bdb47", "name": "The request is not valid.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"action.completed\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "981d5a90-3e78-42a5-b65a-1af92e3679f8", "name": "List webhook endpoints", "request": { "name": "List webhook endpoints", "description": {}, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "488c53e4-d126-451b-b5d2-8dab72fbcfa5", "name": "Endpoints (secrets are never shown again).", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"webhook_endpoint\"\n },\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"object\": {\n \"const\": \"webhook_endpoint\"\n },\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a051631-77e4-4579-833b-388be244851f", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a35b716c-9411-44f2-95a7-e2aa3f687ce6", "name": "Remove a webhook endpoint", "request": { "name": "Remove a webhook endpoint", "description": {}, "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "response": [ { "id": "53413bb2-4a1c-4094-9c88-be2cc7389637", "name": "Removed.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ee5c676f-ea09-4767-a6d7-bedd7f8c2427", "name": "Not found (or belongs to another partner).", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Audit", "description": "Your account’s audit trail.", "item": [ { "id": "919ec749-cf90-4894-92e9-92c76699bb48", "name": "Your audit trail", "request": { "name": "Your audit trail", "description": { "content": "Requests, approvals, safety events and webhook failures for your account. Never contains message content.", "type": "text/plain" }, "url": { "path": [ "v1", "audit-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "response": [ { "id": "ddfd8ce2-d6e3-4ca2-a35c-58e2254252c8", "name": "Newest first.", "originalRequest": { "url": { "path": [ "v1", "audit-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"object\": {\n \"const\": \"list\"\n },\n \"data\": [\n {\n \"id\": \"\",\n \"event\": \"\",\n \"method\": \"\",\n \"path\": \"\",\n \"status\": \"\",\n \"request_id\": \"\",\n \"detail\": {},\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"event\": \"\",\n \"method\": \"\",\n \"path\": \"\",\n \"status\": \"\",\n \"request_id\": \"\",\n \"detail\": null,\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf0bea7-01a7-4d14-a78f-0050ae09bc4c", "name": "Missing, invalid or revoked API key.", "originalRequest": { "url": { "path": [ "v1", "audit-events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "100" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"type\": \"permission_error\",\n \"message\": \"\",\n \"request_id\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{VERA_KEY}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.veraneural.com", "type": "string" }, { "key": "VERA_KEY", "value": "", "type": "string" } ], "info": { "_postman_id": "90cc39ad-5514-41e0-a3fa-754b12e20012", "name": "VERA Partner API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "VERA Partner API, version 2026-10-09. Set the VERA_KEY collection variable to your key. Docs: https://veraneural.com/developers/docs" } }