{ "info": { "_postman_id": "381f37dd-badd-4e39-8bfd-52014bb721c6", "name": "Amigo Account Conversation API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:00:39.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-381f37dd-badd-4e39-8bfd-52014bb721c6" }, "item": [ { "name": "v1", "item": [ { "name": "{organization}", "item": [ { "name": "conversation", "item": [ { "name": "{conversation_id}", "item": [ { "name": "messages", "item": [ { "name": "{message_id}", "item": [ { "name": "source", "item": [ { "name": "Retrieve message source", "id": "c186b87a-88a5-4aef-bfa9-55529e801f4f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "id": "4aa07ca6-6d43-44bb-a7d5-adc30aa5d0df", "key": "organization", "value": "", "description": "(Required) " }, { "id": "d2b3a255-6feb-4db3-8813-106a143633f0", "key": "conversation_id", "value": "b96f47381c51cbfba27dbf87", "description": "(Required) The identifier of the conversation." }, { "id": "dfa26de7-5e5f-49c9-90ac-127cc0bcc26a", "key": "message_id", "value": "82eef99292f7e77b7eb107bf", "description": "(Required) The identifier of the message." } ] }, "description": "Retrieve the raw source of the given message. It's only applicable to messages that did not originate as texts.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Conversation:GetMessage` on the the message." }, "response": [ { "id": "117165bc-be3f-4b56-ab5a-5ec9163db83a", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-117165bc-be3f-4b56-ab5a-5ec9163db83a" }, { "id": "7923235d-a600-4213-9b5b-ea1c7749331a", "name": "The message is a text message.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-7923235d-a600-4213-9b5b-ea1c7749331a" }, { "id": "a979a602-d11c-45df-ba87-186ac37f4b8d", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a979a602-d11c-45df-ba87-186ac37f4b8d" }, { "id": "6ade9418-7f99-4926-8495-b8c12c7f17eb", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-6ade9418-7f99-4926-8495-b8c12c7f17eb" }, { "id": "fcaad8d6-9ad3-4870-98da-4a4f464b93bc", "name": "Specified organization or message is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-fcaad8d6-9ad3-4870-98da-4a4f464b93bc" }, { "id": "e04a6b03-3916-44eb-821d-b9d0373c2948", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e04a6b03-3916-44eb-821d-b9d0373c2948" }, { "id": "bbedc063-bd56-40ff-be0c-94aa6ba37abd", "name": "The user has exceeded the rate limit of 30 request per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-bbedc063-bd56-40ff-be0c-94aa6ba37abd" }, { "id": "9a71fd8b-d29e-4c74-859d-67ef1b74f3be", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/:message_id/source?long_lived=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", ":message_id", "source" ], "query": [ { "description": "Whether to generate a long-lived URL which lasts 12 hours. For security purposes, it's recommended to set this to false as much as possible.", "key": "long_lived", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "message_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9a71fd8b-d29e-4c74-859d-67ef1b74f3be" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-c186b87a-88a5-4aef-bfa9-55529e801f4f" } ], "id": "5e93899f-3f22-4d53-8c1c-9a7e2771cc6c", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-5e93899f-3f22-4d53-8c1c-9a7e2771cc6c" } ], "id": "737a1391-c1e9-4d20-9916-8ff3b692bae0", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-737a1391-c1e9-4d20-9916-8ff3b692bae0" }, { "name": "Get conversation messages", "id": "693b1d45-fb68-43fc-83bf-eea4b59aa193", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=user-message&message_type=agent-message&message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "user-message" }, { "description": "The type of messages to retrieve.", "key": "message_type", "value": "agent-message" }, { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "6f5ee9df-233a-4b28-9712-ba5284fb3f74", "key": "organization", "value": "", "description": "(Required) " }, { "id": "a17e0dca-7263-4cad-bf1d-3386b9dc254f", "key": "conversation_id", "value": "b96f47381c51cbfba27dbf87", "description": "(Required) The identifier of the conversation." } ] }, "description": "Retrieve messages in a conversation, sorted in the specified order, up to the specified limit.\n\n#### Permissions\nThis endpoint is impacted by the following permissions:\n* Only messages that the authenticated user has `Conversation.GetMessage` permission on will be returned." }, "response": [ { "id": "333d47c8-6755-46d9-b99d-0bcfd8e01196", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"messages\": [\n {\n \"id\": \"\",\n \"interaction_id\": \"\",\n \"created_at\": \"\",\n \"sender\": \"\",\n \"message\": \"\",\n \"format\": \"voice\",\n \"message_type\": \"agent-message\"\n },\n {\n \"id\": \"\",\n \"interaction_id\": \"\",\n \"created_at\": \"\",\n \"sender\": \"\",\n \"message\": \"\",\n \"format\": \"text\",\n \"message_type\": \"agent-inner-thought\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-333d47c8-6755-46d9-b99d-0bcfd8e01196" }, { "id": "5574cd47-c001-42fa-8718-0f7f42931509", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-5574cd47-c001-42fa-8718-0f7f42931509" }, { "id": "806f3bee-d046-47c7-9368-4194d4abdbb9", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-806f3bee-d046-47c7-9368-4194d4abdbb9" }, { "id": "334bfe8b-f083-4203-a388-294877d3beca", "name": "Specified organization or conversation is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-334bfe8b-f083-4203-a388-294877d3beca" }, { "id": "77573e6d-2d00-4f3e-a483-50dfb386dc48", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-77573e6d-2d00-4f3e-a483-50dfb386dc48" }, { "id": "b6760375-b4b0-4f89-bc0e-3f282087b8f9", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-b6760375-b4b0-4f89-bc0e-3f282087b8f9" }, { "id": "43a34bf9-a3d6-41f7-b95e-9677c334f02b", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/messages/?message_type=external-event&limit=500&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "messages", "" ], "query": [ { "description": "The type of messages to retrieve.", "key": "message_type", "value": "external-event" }, { "description": "The maximum number of messages to return. At most 500 messages can be returned in one request.", "key": "limit", "value": "500" }, { "description": "The continuation token to use to retrieve the next set of messages.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-43a34bf9-a3d6-41f7-b95e-9677c334f02b" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-693b1d45-fb68-43fc-83bf-eea4b59aa193" } ], "id": "3c3b6e9c-5559-44b5-8d29-14dbd03228df", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3c3b6e9c-5559-44b5-8d29-14dbd03228df" }, { "name": "finish", "item": [ { "name": "Finish a conversation", "id": "001196a0-6c85-486b-82a8-4edf5ed3550b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "id": "8499b37f-d7a0-4af2-bb8f-bedc90014a19", "key": "organization", "value": "", "description": "(Required) " }, { "id": "29090db3-99d6-4119-8b47-4322032127d5", "key": "conversation_id", "value": "f119c0229859bf26488b93ff", "description": "(Required) The identifier of the conversation to finish." } ] }, "description": "Conclude a conversation and asynchronously initiate post-conversation analysis.\n\nThis endpoint should only be called on a started, non-finished conversation. It can only be called when the previous [`Start a conversation`](start-conversation) and\n[`Interact with a conversation`](interact-with-conversation) calls have finished.\n\nIf the conversation has no messages, the conversation is deleted.\n\nIt's possible for some conversations to automatically finish during an [`Interact with a conversation`](interact-with-conversation) call (for instance, if the user explicitly sends a message\nindicating that they're done with the conversation). In that case, this endpoint shouldn't be called, as the [`Interact with a conversation`](interact-with-conversation) endpoint automatically\nwraps up the conversation.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `User:UpdateUserInfo` on the user who started the conversation.\n* `Conversation:FinishConversation` on the conversation." }, "response": [ { "id": "b7232b3d-9850-4705-a7a3-aabfee7e84c2", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-b7232b3d-9850-4705-a7a3-aabfee7e84c2" }, { "id": "7e39e532-0427-43f4-a75f-eb49299dd07c", "name": "The conversation has no interactions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-7e39e532-0427-43f4-a75f-eb49299dd07c" }, { "id": "3bb8ec20-b529-4eae-b681-41b7e9be0bfd", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3bb8ec20-b529-4eae-b681-41b7e9be0bfd" }, { "id": "24908d63-45af-4f39-b852-5384bf37fd23", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-24908d63-45af-4f39-b852-5384bf37fd23" }, { "id": "3436fcf2-4c2e-4e59-ac45-fa534d54007e", "name": "Specified organization or conversation is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3436fcf2-4c2e-4e59-ac45-fa534d54007e" }, { "id": "97662864-9fbf-46c5-b210-4eebb0bff2cd", "name": "The specified conversation is already finished, or a related operation is in process.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-97662864-9fbf-46c5-b210-4eebb0bff2cd" }, { "id": "bcc63f3a-3f3c-40ef-9d5b-bf42754ed054", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-bcc63f3a-3f3c-40ef-9d5b-bf42754ed054" }, { "id": "246815ea-feb2-4682-8258-ea33f916189c", "name": "The user has exceeded the rate limit of 5 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-246815ea-feb2-4682-8258-ea33f916189c" }, { "id": "5540a4c9-7012-41b8-b2fa-a969e34499ce", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/finish/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "finish", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-5540a4c9-7012-41b8-b2fa-a969e34499ce" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-001196a0-6c85-486b-82a8-4edf5ed3550b" } ], "id": "bfddf8cd-5ef8-49b4-b27b-00e19201c053", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-bfddf8cd-5ef8-49b4-b27b-00e19201c053" }, { "name": "interaction", "item": [ { "name": "{interaction_id}", "item": [ { "name": "recommend_responses", "item": [ { "name": "Recommend responses for interaction", "id": "d7aaa075-c4db-4ebb-86b7-0990ae750ce2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "id": "bcd3adae-64fc-4260-9b8c-aa5965546403", "key": "organization", "value": "", "description": "(Required) " }, { "id": "49fc4fe5-edaf-4a87-aa5a-1409b87ff633", "key": "conversation_id", "value": "b96f47381c51cbfba27dbf87", "description": "(Required) The identifier of the conversation." }, { "id": "e8f58946-8c53-46f9-9574-012865c214f1", "key": "interaction_id", "value": "22930c58746d57e8ff30c18b", "description": "(Required) The identifier of the most recent interaction." } ] }, "description": "Generate a recommended response for the user to send based on the existing chat history. This should be called when the most recent interaction\nhad concluded for a while but the user still hasn't responded.\n\n#### Permissions:\nThis endpoint requires the following permissions:\n* `Conversation:GetRecommendedResponses` on this conversation." }, "response": [ { "id": "867c1bbf-05b5-4757-a1ce-76d9bdc96027", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"recommended_responses\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-867c1bbf-05b5-4757-a1ce-76d9bdc96027" }, { "id": "c9b68a95-e268-48bb-8fe7-369134281702", "name": "The conversation is finished, or the supplied interaction ID doesn't correspond to the latest, completed interaction.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-c9b68a95-e268-48bb-8fe7-369134281702" }, { "id": "6d0aacc5-6a08-418a-98df-9af2e3405efa", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-6d0aacc5-6a08-418a-98df-9af2e3405efa" }, { "id": "fa18ba2e-0df2-4e07-bec0-457e9db8b418", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-fa18ba2e-0df2-4e07-bec0-457e9db8b418" }, { "id": "c7a4eafa-7d0e-4532-81ac-0956a5df31a6", "name": "Specified organization or conversation is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-c7a4eafa-7d0e-4532-81ac-0956a5df31a6" }, { "id": "73646e8d-3c81-4c78-b0be-9cc4930dc7f6", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-73646e8d-3c81-4c78-b0be-9cc4930dc7f6" }, { "id": "81d700f4-bb52-460f-a459-0990234ae84a", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-81d700f4-bb52-460f-a459-0990234ae84a" }, { "id": "4a25231d-bd97-4abd-8228-9b7b9a172a3f", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"context\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/recommend_responses", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "recommend_responses" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-4a25231d-bd97-4abd-8228-9b7b9a172a3f" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-d7aaa075-c4db-4ebb-86b7-0990ae750ce2" } ], "id": "013e8adb-dbdc-4d19-9612-ce4d54295f28", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-013e8adb-dbdc-4d19-9612-ce4d54295f28" }, { "name": "insights", "item": [ { "name": "Get interaction insights", "id": "a82fe524-92df-4336-88a6-9b788b43ef08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "id": "a4479e60-c00d-4b1f-b490-887c07ca8bcd", "key": "organization", "value": "", "description": "(Required) " }, { "id": "695adf9f-a2c2-4945-9475-c0fc3427cbfe", "key": "conversation_id", "value": "b96f47381c51cbfba27dbf87", "description": "(Required) The identifier of the conversation." }, { "id": "1c2f827a-962f-4685-a93b-ec686c56c999", "key": "interaction_id", "value": "92a427e3a125f42f3bd84634", "description": "(Required) The identifier of the interaction." } ] }, "description": "Retrieve insights about the agent's message for a given interaction.\n\n#### Permissions:\nThis endpoint requires the following permissions:\n* `Conversation:GetInteractionInsights` on the conversation.\n* `Organization:GetServiceHierarchicalStateMachine` on the state machine that the current interaction is in.\n\nThis endpoint may be impacted by the following permissions:\n* Only reflection messages for which the authenticated user has the `Conversation:GetMessage` permission are included in the response." }, "response": [ { "id": "258e2d6f-279d-4ccb-bd90-c803bf35d2f7", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"current_state_name\": \"\",\n \"current_state_action\": \"\",\n \"current_state_objective\": \"\",\n \"state_transition_logs\": [\n {\n \"previous_state\": \"\",\n \"previous_service_hierarchical_state_machine_version_info\": \"\",\n \"next_state\": \"\",\n \"next_service_hierarchical_state_machine_version_info\": \"\",\n \"previous_state_exit_condition_description\": \"\",\n \"tool_call_logs\": [\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"cupidatat_8cf\": true,\n \"labore_2\": -28494291.56878829,\n \"dolor_4b\": -51555275,\n \"elit_7a\": 16564749.147245899\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"fugiat_ecf\": \"qu\",\n \"proidentf\": \"aliqua\",\n \"proident_74\": -81989834\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ],\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"quis__\": 79103557.01127794,\n \"in_e8\": true,\n \"occaecat05a\": -16517276.022933021\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"enim2\": false,\n \"ex_d5c\": false\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ]\n ],\n \"type\": \"action\"\n },\n {\n \"previous_state\": \"\",\n \"previous_service_hierarchical_state_machine_version_info\": \"\",\n \"next_state\": \"\",\n \"next_service_hierarchical_state_machine_version_info\": \"\",\n \"previous_state_exit_condition_description\": \"\",\n \"tool_call_logs\": [\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"qui__ba\": 75040742,\n \"sunt_0_9\": \"Duis nisi\",\n \"adipisicing_b\": -353440.3842687905\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"magna_3a\": 83425323.13486707,\n \"ipsum4\": true,\n \"aliqua_7\": \"minim l\",\n \"est98\": -88303490\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ],\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"irure_f6b\": false,\n \"laboris_7_8\": \"veniam pariatur est\",\n \"Excepteurc2\": \"\"\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"minim_8\": true\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ]\n ],\n \"type\": \"action\"\n }\n ],\n \"working_memory\": [\n {\n \"content\": \"\",\n \"context\": \"\"\n },\n {\n \"content\": \"\",\n \"context\": \"\"\n }\n ],\n \"reflections\": [\n \"\",\n \"\"\n ],\n \"triggered_dynamic_behavior_set_version_info\": \"\",\n \"select_next_action_tool_call_logs\": [\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"voluptate_07\": -59752695.18100505,\n \"ut_f\": false,\n \"occaecat_34e\": false\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"dolor626\": false,\n \"eiusmode0a\": -78112103.69395071,\n \"animc0\": \"sint irure nostrud id sit\",\n \"do_8e7\": -64406850.19548504,\n \"Excepteurb\": -85722566.99862608\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ],\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"pariatur_d3\": true\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"Duise6\": -24648513,\n \"proident_02\": -81421133\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ]\n ],\n \"engage_user_tool_call_logs\": [\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"adipisicing2\": true\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"Excepteure8\": \"dolore ipsum deserunt occaec\",\n \"ut_d\": \"ad exercitation cupidatat\"\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ],\n [\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"aliquip_77\": 29748033,\n \"nostrud3\": \"ex cupidatat tempor Excepteur\",\n \"laborum_56\": -59403881.38725026,\n \"nonb\": -13901759\n },\n \"output\": \"\",\n \"duration\": \"\"\n },\n {\n \"tool_name\": \"\",\n \"tool_id\": \"\",\n \"tool_version\": \"\",\n \"input\": {\n \"pariatur_f\": true\n },\n \"output\": \"\",\n \"duration\": \"\"\n }\n ]\n ]\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-258e2d6f-279d-4ccb-bd90-c803bf35d2f7" }, { "id": "9208c1bc-2669-4b1b-a362-d748b23556eb", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9208c1bc-2669-4b1b-a362-d748b23556eb" }, { "id": "27432710-b871-4b0f-8368-be709033da52", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-27432710-b871-4b0f-8368-be709033da52" }, { "id": "5ad132d3-8070-483d-aca5-d398b11e8fec", "name": "Specified organization, conversation, or interaction is not found.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-5ad132d3-8070-483d-aca5-d398b11e8fec" }, { "id": "a5217ee7-ed8f-40cd-900e-5cb67b36d39e", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a5217ee7-ed8f-40cd-900e-5cb67b36d39e" }, { "id": "c2155311-42db-4999-b5f4-60f33348a755", "name": "The user has exceeded the rate limit of 20 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-c2155311-42db-4999-b5f4-60f33348a755" }, { "id": "c9a0908f-0762-4f37-a85f-f66c679782a0", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interaction/:interaction_id/insights", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interaction", ":interaction_id", "insights" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" }, { "key": "interaction_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-c9a0908f-0762-4f37-a85f-f66c679782a0" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a82fe524-92df-4336-88a6-9b788b43ef08" } ], "id": "ee86ade1-780b-4588-a1e6-bc5861da35e2", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-ee86ade1-780b-4588-a1e6-bc5861da35e2" } ], "id": "9608e5a4-8395-4a8d-b3f8-359ac4355c1b", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9608e5a4-8395-4a8d-b3f8-359ac4355c1b" } ], "id": "3521296f-6d03-4bb3-bac8-4d73309a00d2", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3521296f-6d03-4bb3-bac8-4d73309a00d2" }, { "name": "interact", "item": [ { "name": "Interact with a conversation", "id": "e196b09a-731d-4e6e-89f5-2c663b8d8732", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/x-ndjson" } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "id": "5cd14fcd-c256-4b27-9e27-c7624955a2e6", "key": "organization", "value": "", "description": "(Required) " }, { "id": "04f00e21-3c00-4d68-b111-b9fa588af6f7", "key": "conversation_id", "value": "7ec26f05b6ff0499e9bc1972", "description": "(Required) The identifier of the conversation to send a message to." } ] }, "description": "Send a new user message to the conversation. The endpoint will perform analysis and generate an agent message in response.\n\nA `UserMessageAvailableEvent` will be the first event in the response, which includes the user message if it's sent as text, or the transcribed message if it's sent as voice.\nA series of `CurrentAgentActionEvent`s will follow, which indicates steps in the agent's thinking process. Then the agent message is generated sequentially in pieces, with each piece\nbeing sent as a `NewMessageEvent` in the response. After all the pieces are sent, an `InteractionCompleteEvent` is sent. Depending on the `conversation_completed` property in this event, the conversation will be awaiting\na new message from the user, or it might automatically end (for instance, because the user message indicates the user wants to end the session), while the conversation is marked as finished and the post-conversation\nanalysis asynchronously initiated. The connection will then terminate.\n\nAny further action on the conversation is only allowed after the connection is terminated.\n\nA 200 status code doesn't indicate the successful completion of this endpoint, because the status code is transmitted before the stream starts. At any point during the stream,\nan `ErrorEvent` might be sent, which indicates that an error has occurred. The connection will be immediately closed after.\n\nThis endpoint can only be called on a conversation that has started but not finished.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `User:UpdateUserInfo` on the user who started the conversation.\n* `Conversation:InteractWithConversation` on the conversation.\n\nThis endpoint may be impacted by the following permissions:\n* `CurrentAgentActionEvent`s are only emitted if the authenticated user has the `Conversation:GetInteractionInsights` permission." }, "response": [ { "id": "32878217-c306-4f36-a664-ae19ca772dd5", "name": "\nSucceeded. The response will be a stream of events in JSON format separated by newlines. The server will transmit an event as soon as one is available,\nso the client should respond to the events as soon as one arrives, and keep listening until the server", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/x-ndjson" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/x-ndjson" } ], "cookie": [], "responseTime": null, "body": "{\n \"message_id\": \"\",\n \"interaction_id\": \"\",\n \"full_message\": \"\",\n \"conversation_completed\": \"\",\n \"type\": \"interaction-complete\"\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-32878217-c306-4f36-a664-ae19ca772dd5" }, { "id": "3cbb57ee-f9c5-469f-9c24-1086f6f339fc", "name": "\nThis may occur for the following reasons:\n* The user message is empty.\n* The preferred language does not support voice transcription or response.\n* The `response_audio_format` field is not set when voice output is requested.\n* The timestamps for external", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3cbb57ee-f9c5-469f-9c24-1086f6f339fc" }, { "id": "1efc8140-ff14-4ca7-b704-3f167820e8d0", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-1efc8140-ff14-4ca7-b704-3f167820e8d0" }, { "id": "b5be4c72-aa86-4666-9c86-f5a9c9f9d91b", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-b5be4c72-aa86-4666-9c86-f5a9c9f9d91b" }, { "id": "ef1489bd-385b-45a0-97fa-08f52a1c5ab3", "name": "Specified organization or conversation is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-ef1489bd-385b-45a0-97fa-08f52a1c5ab3" }, { "id": "a45e2a56-663b-4ae5-a3d2-6e0f03d8b260", "name": "The request body stream timed out.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a45e2a56-663b-4ae5-a3d2-6e0f03d8b260" }, { "id": "afdd7fc9-2973-4a7e-92d3-31fafac1ec37", "name": "The specified conversation is already finished, or a related operation is in process.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-afdd7fc9-2973-4a7e-92d3-31fafac1ec37" }, { "id": "89eb144d-5dda-4524-8ea5-925804eaa075", "name": "The format of the supplied audio file is not supported.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-89eb144d-5dda-4524-8ea5-925804eaa075" }, { "id": "e82886fa-6c93-4384-b320-da142e0a70ed", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e82886fa-6c93-4384-b320-da142e0a70ed" }, { "id": "1a8b4f6c-6583-4b25-ab3d-cfbd873f518f", "name": "The user has exceeded the rate limit of 15 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-1a8b4f6c-6583-4b25-ab3d-cfbd873f518f" }, { "id": "dc48a316-98f2-4a7e-87b9-3fe113652c74", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "initial_message_type", "value": "", "type": "text" }, { "key": "recorded_message", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/interact?request_format=voice&response_format=voice¤t_agent_action_type=^.*$&type=mp3", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "interact" ], "query": [ { "description": "(Required) The format in which the user message is delivered to the server.", "key": "request_format", "value": "voice" }, { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" }, { "description": "Configuration for the user message audio. This is only required if `request_format` is set to `voice`.", "key": "type", "value": "mp3" } ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-dc48a316-98f2-4a7e-87b9-3fe113652c74" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e196b09a-731d-4e6e-89f5-2c663b8d8732" } ], "id": "32cace34-8cbc-4cf3-b4c4-e8630cb8dad8", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-32cace34-8cbc-4cf3-b4c4-e8630cb8dad8" }, { "name": "tags", "item": [ { "name": "Modify tags of a conversation", "id": "dee7eae9-c746-439b-a0c7-644975b65e25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "id": "78036c49-d5b2-494f-a490-d79692fe8cf2", "key": "organization", "value": "", "description": "(Required) " }, { "id": "7efcbeb4-7ad6-48e4-ada7-5bbe89e6f719", "key": "conversation_id", "value": "64b7203b85576c4d4e8754ef", "description": "(Required) " } ] }, "description": "Modify the tags of a conversation.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Conversation:ModifyConversation` for the conversation to modify tags for." }, "response": [ { "id": "d03832b4-9359-47e6-aceb-05c1f40a6f90", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-d03832b4-9359-47e6-aceb-05c1f40a6f90" }, { "id": "2d8103b7-21a0-4ddd-a63a-1b9d6a63d5e6", "name": "The conversation cannot contain more than 20 tags.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-2d8103b7-21a0-4ddd-a63a-1b9d6a63d5e6" }, { "id": "ac614013-f1f7-4757-be20-a22cc1f61a3f", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-ac614013-f1f7-4757-be20-a22cc1f61a3f" }, { "id": "972247fd-76c5-46f1-b19c-918dfcc8bc25", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-972247fd-76c5-46f1-b19c-918dfcc8bc25" }, { "id": "e7ab1255-ef4f-4389-9446-bff2e107bddc", "name": "Specified organization or conversation is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e7ab1255-ef4f-4389-9446-bff2e107bddc" }, { "id": "02a8a52a-d389-4944-8c05-a249b9b59c70", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-02a8a52a-d389-4944-8c05-a249b9b59c70" }, { "id": "7a82c19d-3e72-4bf1-a189-76266d03353d", "name": "The user has exceeded the rate limit of 50 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-7a82c19d-3e72-4bf1-a189-76266d03353d" }, { "id": "e814e35e-12b0-48f7-a301-155d4ba06ac6", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"updates\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/:conversation_id/tags/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", ":conversation_id", "tags", "" ], "variable": [ { "key": "organization" }, { "key": "conversation_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e814e35e-12b0-48f7-a301-155d4ba06ac6" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-dee7eae9-c746-439b-a0c7-644975b65e25" } ], "id": "a446bf24-8a2d-4e3c-ad94-5bb328df60d6", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a446bf24-8a2d-4e3c-ad94-5bb328df60d6" } ], "id": "eb0145f5-7b0c-404d-bef6-c270b4706f97", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-eb0145f5-7b0c-404d-bef6-c270b4706f97" }, { "name": "conversation_starter", "item": [ { "name": "Generate conversation starters for a service", "id": "1e644f77-7541-4087-9fdf-49796ed260d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "id": "97fd5f17-18e6-4b56-a846-a1dcfe9f7343", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Generate conversation starters for a service.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Conversation:CreateConversation` for a hypothetical new conversation created using the same setting." }, "response": [ { "id": "e258bc62-f543-473b-9e51-acd60f1fff2e", "name": "Succeeded.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"prompts\": [\n {\n \"prompt\": \"\",\n \"facets\": [\n \"\",\n \"\"\n ]\n },\n {\n \"prompt\": \"\",\n \"facets\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e258bc62-f543-473b-9e51-acd60f1fff2e" }, { "id": "58573ca7-f011-4384-9157-8089ba19095b", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-58573ca7-f011-4384-9157-8089ba19095b" }, { "id": "a539dfca-921d-496d-a251-199091c05434", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-a539dfca-921d-496d-a251-199091c05434" }, { "id": "f7431340-7e4b-44d4-b43c-bba07cda5c6a", "name": "Service not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-f7431340-7e4b-44d4-b43c-bba07cda5c6a" }, { "id": "d6b846d1-2f78-4fa7-ab0f-206ff8e6abe7", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-d6b846d1-2f78-4fa7-ab0f-206ff8e6abe7" }, { "id": "b5f50274-7522-4034-b30c-fd522f9d3e0d", "name": "The user has exceeded the rate limit of 10 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-b5f50274-7522-4034-b30c-fd522f9d3e0d" }, { "id": "3d44a07e-31ef-4035-8066-1c6c647aad96", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"ae7db5f1b198aa1235fdf0ff\",\n \"facets\": [\n \"\"\n ],\n \"min_count\": \"\",\n \"max_count\": \"\",\n \"generation_instructions\": \"\",\n \"service_version_set_name\": \"release\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/conversation_starter", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "conversation_starter" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-3d44a07e-31ef-4035-8066-1c6c647aad96" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-1e644f77-7541-4087-9fdf-49796ed260d8" } ], "id": "9451d588-6ad5-4ac6-bbec-111a026fdb51", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9451d588-6ad5-4ac6-bbec-111a026fdb51" }, { "name": "Create a conversation", "id": "2788fe6b-1ed5-45f2-9d57-88b1a3363062", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/x-ndjson" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "id": "624b72f5-a283-4053-8e08-c7eda7c76396", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Create a new conversation and start it. The user must not have any unfinished conversations that belong to the same service.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Conversation:CreateConversation` for the new conversation.\n\nThis endpoint may be impacted by the following permissions:\n* `CurrentAgentActionEvent`s are only emitted if the authenticated user has the `Conversation:GetInteractionInsights` permission." }, "response": [ { "id": "8971b00e-5aa6-4f5e-86da-5adc799d6855", "name": "\nSucceeded. The response will be a stream of events in JSON format separated by newlines. The server will transmit an event as soon as one is available,\nso the client should respond to the events as soon as one arrives, and keep listening until the server", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/x-ndjson" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/x-ndjson" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversation_id\": \"\",\n \"type\": \"conversation-created\"\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-8971b00e-5aa6-4f5e-86da-5adc799d6855" }, { "id": "6f5a7ce6-8830-4964-ae7a-6faf3b9b5a40", "name": "\nThis may occur for the following reasons:\n* Attempting to start a conversation when other unfinished conversations exist.\n* The preferred language does not support voice response.\n* The `response_audio_format` field is not set when voice output is reques", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-6f5a7ce6-8830-4964-ae7a-6faf3b9b5a40" }, { "id": "ca5c8587-d234-4f8e-8bd2-ae51eae4b31c", "name": "Invalid authorization credentials.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-ca5c8587-d234-4f8e-8bd2-ae51eae4b31c" }, { "id": "9fc4a58a-fcf5-4358-ba4a-d84ac54baee0", "name": "Missing required permissions.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9fc4a58a-fcf5-4358-ba4a-d84ac54baee0" }, { "id": "aa3f5495-ce39-414e-94a3-9e145d464299", "name": "Specified organization, service, or version set is not found.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-aa3f5495-ce39-414e-94a3-9e145d464299" }, { "id": "87e5c65a-decd-4481-8f59-9cf7a122b866", "name": "A related operation is in progress.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-87e5c65a-decd-4481-8f59-9cf7a122b866" }, { "id": "d87f2853-448d-459d-b1cf-30e3bc19ed60", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-d87f2853-448d-459d-b1cf-30e3bc19ed60" }, { "id": "ee61d032-adec-474a-bf99-59ec7479ae72", "name": "The user has exceeded the rate limit of 5 requests per minute for this endpoint.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-ee61d032-adec-474a-bf99-59ec7479ae72" }, { "id": "f60e5bcb-3af7-49f4-84fc-f77415070d01", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "POST", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"eddfd54cffa93a9e1074cacd\",\n \"service_version_set_name\": \"release\",\n \"initial_message\": \"\",\n \"initial_message_type\": \"user-message\",\n \"tags\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?response_format=voice¤t_agent_action_type=^.*$", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "(Required) The format of the response that will be sent to the user.", "key": "response_format", "value": "voice" }, { "description": "A regex for filtering the type of the current agent action to return. By default, all are returned. If you don't want to receive any events, set this to a regex that matches nothing, for instance `^$`.", "key": "current_agent_action_type", "value": "^.*$" } ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-f60e5bcb-3af7-49f4-84fc-f77415070d01" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-2788fe6b-1ed5-45f2-9d57-88b1a3363062" }, { "name": "Get conversations", "id": "e73dfd04-8aca-4c23-b5f3-fc15a1504c92", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "3af85fc4-d3ca-4e7a-be99-c6b08046d1d6", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Retrieve conversations in an organization based on supplied filters.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* The `final_message` field in the response is only non-empty if the authenticated user has the `Conversation.GetMessage` permission on the final message.\n* The `version_set_info` field in the response is only non-empty if the authenticated user has the `Service.GetVersionSet` permission on the version set.\n* Only conversations for which the user has the `Conversation.GetConversation` permission are returned." }, "response": [ { "id": "9a4db4ca-eed1-4f7e-b9f8-f55599c28aed", "name": "Succeeded.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversations\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"created_at\": \"\",\n \"is_finished\": \"\",\n \"is_analyzed\": \"\",\n \"completed_post_processings\": [\n \"generate-user-models\",\n \"compute-metrics\"\n ],\n \"final_message\": \"\",\n \"service_id\": \"\",\n \"version_set_info\": {\n \"name\": \"\",\n \"agent_version_info\": \"\",\n \"service_hierarchical_state_machine_version_info\": \"\",\n \"llm_model_preferences\": {\n \"est9\": {\n \"llm_name\": \"\",\n \"params\": {}\n },\n \"culpa6f\": {\n \"llm_name\": \"\",\n \"params\": {}\n }\n }\n },\n \"num_messages\": \"\",\n \"tags\": {\n \"anim_4ff\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"created_at\": \"\",\n \"is_finished\": \"\",\n \"is_analyzed\": \"\",\n \"completed_post_processings\": [\n \"generate-user-models\",\n \"extract-memories\"\n ],\n \"final_message\": \"\",\n \"service_id\": \"\",\n \"version_set_info\": {\n \"name\": \"\",\n \"agent_version_info\": \"\",\n \"service_hierarchical_state_machine_version_info\": \"\",\n \"llm_model_preferences\": {\n \"reprehenderitc9\": {\n \"llm_name\": \"\",\n \"params\": {}\n }\n }\n },\n \"num_messages\": \"\",\n \"tags\": {\n \"qui7\": \"\",\n \"minim_de\": \"\",\n \"et_c\": \"\",\n \"amet3_0\": \"\"\n }\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-9a4db4ca-eed1-4f7e-b9f8-f55599c28aed" }, { "id": "58a28456-4d41-41f7-bea7-98920756c012", "name": "Invalid authorization credentials.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-58a28456-4d41-41f7-bea7-98920756c012" }, { "id": "16fd3c6c-dbfd-448c-937f-ef1ae22267c4", "name": "Missing required permissions.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-16fd3c6c-dbfd-448c-937f-ef1ae22267c4" }, { "id": "0b096e53-f336-44bd-8039-97787f7f0abc", "name": "Invalid request path parameter or query parameter failed validation.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-0b096e53-f336-44bd-8039-97787f7f0abc" }, { "id": "87283382-654b-48c9-aeb2-ee0edf083e11", "name": "The user has exceeded the rate limit of 15 requests per minute for this endpoint.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-87283382-654b-48c9-aeb2-ee0edf083e11" }, { "id": "df86dbe9-87b1-4dc0-afcf-f2c8aaac6694", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "GET", "header": [ { "description": "The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.", "key": "x-mongo-cluster-name", "value": "" }, { "key": "Sec-WebSocket-Protocol", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:organization/conversation/?is_finished=&limit=150&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "conversation", "" ], "query": [ { "description": "Whether the conversation is finished.", "key": "is_finished", "value": "" }, { "description": "The maximum number of conversations to retrieve.", "key": "limit", "value": "150" }, { "description": "The continuation token returned from the previous response to retrieve the next set of conversations.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-df86dbe9-87b1-4dc0-afcf-f2c8aaac6694" } ], "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-e73dfd04-8aca-4c23-b5f3-fc15a1504c92" } ], "id": "0beb159b-9abc-455a-9efe-2bc3ed796a9d", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-0beb159b-9abc-455a-9efe-2bc3ed796a9d" } ], "id": "fdee1a78-86d0-4bbe-81c7-c4083bf36191", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-fdee1a78-86d0-4bbe-81c7-c4083bf36191" } ], "id": "920375ea-b014-411f-ad74-b8795fc7ecdd", "createdAt": "2026-07-28T01:00:40.000Z", "updatedAt": "2026-07-28T01:00:40.000Z", "uid": "35240-920375ea-b014-411f-ad74-b8795fc7ecdd" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.amigo.ai" } ] }