{ "info": { "_postman_id": "e641130c-610e-4967-90e3-c252a8f6ca69", "name": "Amigo Account Organization API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-e641130c-610e-4967-90e3-c252a8f6ca69" }, "item": [ { "name": "v1", "item": [ { "name": "{organization}", "item": [ { "name": "organization", "item": [ { "name": "agent", "item": [ { "name": "{agent_id}", "item": [ { "name": "version", "item": [ { "name": "Get agent versions", "id": "6c2c2134-02c0-4ef0-bfe0-0ac8019345f8", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "9f278ffb-be02-4b7a-be0e-c1ca62efa1c6", "key": "organization", "value": "", "description": "(Required) " }, { "id": "fb36d6d7-4fa1-48f4-a017-cf82b9c07058", "key": "agent_id", "value": "8a1103529f02988de3d57b16", "description": "(Required) The ID of the agent." } ] }, "description": "Retrieve the versions of an agent.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:GetAgent` for the agent to retrieve." }, "response": [ { "id": "95ccf88b-34cc-4026-980c-9dd93a2cd123", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"agent_versions\": [\n {\n \"org_id\": \"\",\n \"agent_id\": \"\",\n \"version\": \"\",\n \"voice_config\": {\n \"voice_id\": \"\",\n \"stability\": 0,\n \"similarity_boost\": 0,\n \"style\": 0\n },\n \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n }\n },\n {\n \"org_id\": \"\",\n \"agent_id\": \"\",\n \"version\": \"\",\n \"voice_config\": {\n \"voice_id\": \"\",\n \"stability\": 0,\n \"similarity_boost\": 0,\n \"style\": 0\n },\n \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n }\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-95ccf88b-34cc-4026-980c-9dd93a2cd123" }, { "id": "8f3b0521-1f92-4182-8f6c-8f310e5ac305", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8f3b0521-1f92-4182-8f6c-8f310e5ac305" }, { "id": "dddd6ced-7032-49a8-bcfb-735757440c62", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-dddd6ced-7032-49a8-bcfb-735757440c62" }, { "id": "0da055eb-3101-4a18-93d7-0635b6476e0b", "name": "Specified organization or agent 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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0da055eb-3101-4a18-93d7-0635b6476e0b" }, { "id": "18f559c7-5386-4e31-b285-eeeeb4dce981", "name": "Invalid request path parameter or request 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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-18f559c7-5386-4e31-b285-eeeeb4dce981" }, { "id": "c36306b5-c537-40ae-b735-c3497ba05ccc", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c36306b5-c537-40ae-b735-c3497ba05ccc" }, { "id": "eebf795d-7aa3-4f5a-8ca5-222838051964", "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/organization/agent/:agent_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "version" ], "query": [ { "description": "The versions of the agent to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of agent versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agent version.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-eebf795d-7aa3-4f5a-8ca5-222838051964" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-6c2c2134-02c0-4ef0-bfe0-0ac8019345f8" } ], "id": "b2ae7eb3-699b-4c04-bcff-13ae49cc745c", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-b2ae7eb3-699b-4c04-bcff-13ae49cc745c" }, { "name": "Create an agent version", "id": "7bc632e4-1cc5-4463-8823-f0b7d3c8e238", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "id": "5bebe1b0-701e-462f-a39c-1b2ecca3a58b", "key": "organization", "value": "", "description": "(Required) " }, { "id": "40334608-a7b0-4dcc-b6ec-92919931e50f", "key": "agent_id", "value": "2c66b975dd54e1af63d062a5", "description": "(Required) The ID of the agent to create a new version for." } ] }, "description": "Create a new version of the given agent. If there's no existing versions, all fields in the request must be filled and they will be used to\ncreate the initial version of the agent. Otherwise, only fill the fields that need to be updated, and the new version will retain other fields\nfrom the previous latest version.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:CreateAgentVersion` for the new version of the agent." }, "response": [ { "id": "1696f338-20e1-4476-889e-1541fc3e33ed", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": \"\",\n \"created_at\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-1696f338-20e1-4476-889e-1541fc3e33ed" }, { "id": "9ea84764-84aa-4c30-b1ec-adfc5807fae3", "name": "Attempt to create the initial version for an agent, but not all fields in the request object are defined. Or, the specified voice ID doesn't exist.", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9ea84764-84aa-4c30-b1ec-adfc5807fae3" }, { "id": "bb4bf08c-14ed-477d-9f92-3eb291a527ec", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bb4bf08c-14ed-477d-9f92-3eb291a527ec" }, { "id": "be3889f4-bb60-43c3-a432-adbf6caf5f1f", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-be3889f4-bb60-43c3-a432-adbf6caf5f1f" }, { "id": "53946e78-baf9-4a1a-8c5a-a93ca3b59326", "name": "The specified organization or agent does not exist.", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-53946e78-baf9-4a1a-8c5a-a93ca3b59326" }, { "id": "3382aa97-4ff2-4bff-a032-19d74db8a229", "name": "The specified version is not the expected next version for the agent.", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3382aa97-4ff2-4bff-a032-19d74db8a229" }, { "id": "5576be3a-bdb9-4078-8c3e-b205df16368a", "name": "Invalid request path parameter, request body, or request query 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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5576be3a-bdb9-4078-8c3e-b205df16368a" }, { "id": "c6b1e47c-2cbf-46e0-9bc8-58f76c776edf", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c6b1e47c-2cbf-46e0-9bc8-58f76c776edf" }, { "id": "8d6a9fb4-d30f-43dd-afd3-6d1b631c89d5", "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 \"initials\": \"\",\n \"identity\": {\n \"name\": \"\",\n \"role\": \"\",\n \"developed_by\": \"\",\n \"default_spoken_language\": \"usk\",\n \"relationship_to_developer\": {\n \"ownership\": \"\",\n \"type\": \"\",\n \"conversation_visibility\": \"\",\n \"thought_visibility\": \"\"\n }\n },\n \"background\": \"\",\n \"behaviors\": [\n \"\",\n \"\"\n ],\n \"communication_patterns\": [\n \"\",\n \"\"\n ],\n \"voice_config\": {\n \"voice_id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent/:agent_id/?version=", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "query": [ { "description": "The version number of the new agent version. If specified, this endpoint throws an error if the next version of the agent in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" } ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8d6a9fb4-d30f-43dd-afd3-6d1b631c89d5" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-7bc632e4-1cc5-4463-8823-f0b7d3c8e238" }, { "name": "Delete an agent", "id": "0eaefea1-b479-4fdf-ac35-430b4fe7e08b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "id": "b53df87b-9c86-4d0d-933a-86caf27df428", "key": "organization", "value": "", "description": "(Required) " }, { "id": "5badf1ae-6910-40e0-a439-183143a0738f", "key": "agent_id", "value": "432476318e89c2f949425c27", "description": "(Required) The ID of the agent to delete" } ] }, "description": "Delete the specified agent from the organization. In practice, this endpoint marks the agent as deprecated, but will not delete\nthis agent nor any of its versions. It does prevent new services (or inactive services to be activated) from using this agent.\n\nAn error will be raised if this endpoint is called when an active service still utilizes this agent. However, any ongoing conversation using this agent\nwill continue to work.\n\n#### Permissions:\n* `Organization:DeleteAgent` for the agent to delete." }, "response": [ { "id": "17cd2c3f-9483-4d52-bc38-280d97871808", "name": "Succeeded.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-17cd2c3f-9483-4d52-bc38-280d97871808" }, { "id": "bfca2531-6c9e-4d2d-b6c0-7d1d8ab0c508", "name": "An active service exists that utilizes this agent.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bfca2531-6c9e-4d2d-b6c0-7d1d8ab0c508" }, { "id": "c2b69dd8-9aee-40df-8c79-f9f15b88837d", "name": "Invalid authorization credentials.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c2b69dd8-9aee-40df-8c79-f9f15b88837d" }, { "id": "c5c0c113-4619-4a96-a0ea-17a2fcec5c19", "name": "Missing required permissions.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c5c0c113-4619-4a96-a0ea-17a2fcec5c19" }, { "id": "43d07ff9-cd8b-4572-b42d-c66ee07e217c", "name": "The specified organization or agent does not exist.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-43d07ff9-cd8b-4572-b42d-c66ee07e217c" }, { "id": "bb011192-dad0-4f69-aec2-e1dc2cfa4d52", "name": "The specified agent is already deleted", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bb011192-dad0-4f69-aec2-e1dc2cfa4d52" }, { "id": "afd226ed-5b27-423d-97de-be7e184484c9", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-afd226ed-5b27-423d-97de-be7e184484c9" }, { "id": "84c08de4-b770-4843-a6ea-23c27da20c6e", "name": "The user has exceeded the rate limit of 10 requests per minute for this endpoint.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-84c08de4-b770-4843-a6ea-23c27da20c6e" }, { "id": "2744a231-d40f-45c9-8650-598a0c21a251", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "DELETE", "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/organization/agent/:agent_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent", ":agent_id", "" ], "variable": [ { "key": "organization" }, { "key": "agent_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2744a231-d40f-45c9-8650-598a0c21a251" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0eaefea1-b479-4fdf-ac35-430b4fe7e08b" } ], "id": "74d4606d-64e6-474c-95c2-32e53f537ed6", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-74d4606d-64e6-474c-95c2-32e53f537ed6" }, { "name": "Create an agent", "id": "490227e8-c2f0-46fb-ae9e-b2186452f716", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "id": "f05f10fd-d667-4a82-9d2c-8f3ee213b8ed", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Create a new agent for the given organization. No default version for the agent will be created, so one must\nlater to create a version for this agent so it can be used in a service.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:CreateAgent` for the new agent." }, "response": [ { "id": "511dfe9b-7a90-420a-b777-a1a20cfe444f", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-511dfe9b-7a90-420a-b777-a1a20cfe444f" }, { "id": "2ca319f3-a5be-4c28-afd0-b22a309c8c10", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2ca319f3-a5be-4c28-afd0-b22a309c8c10" }, { "id": "994e5019-7713-4ebe-a15a-ae6a4141d087", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-994e5019-7713-4ebe-a15a-ae6a4141d087" }, { "id": "f3bdaab4-18b8-434f-8e17-0d012aed0b1b", "name": "The specified organization does not exist.", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f3bdaab4-18b8-434f-8e17-0d012aed0b1b" }, { "id": "2a66bd4a-a2aa-47aa-a530-70020e6c6559", "name": "An `Agent` with the same name already exists.", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2a66bd4a-a2aa-47aa-a530-70020e6c6559" }, { "id": "2bdc9359-c457-4dfd-92e6-61460166035b", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2bdc9359-c457-4dfd-92e6-61460166035b" }, { "id": "aba7dbe5-2d5d-417c-bcc9-9b7f5c66c998", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-aba7dbe5-2d5d-417c-bcc9-9b7f5c66c998" }, { "id": "7e60962f-49bd-470a-a8da-490ea07f9d70", "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 \"agent_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/agent", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-7e60962f-49bd-470a-a8da-490ea07f9d70" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-490227e8-c2f0-46fb-ae9e-b2186452f716" }, { "name": "Get agents for an organization", "id": "2e2cbb7f-a97c-406b-bb2b-8123ad0789e4", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "85665200-db09-4d5a-986b-1b36c6e3d7ba", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Return a list of agents for the organization.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* Only agents that the authenticated user has the `Organization:GetAgent` permission on will be returned." }, "response": [ { "id": "8f3d0d3d-a4c3-4c55-953d-30933311340b", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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 \"agents\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"deprecated\": \"\",\n \"latest_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"deprecated\": \"\",\n \"latest_version\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8f3d0d3d-a4c3-4c55-953d-30933311340b" }, { "id": "2b4ad3be-ce5e-45e3-bf85-f3e01d6ac860", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2b4ad3be-ce5e-45e3-bf85-f3e01d6ac860" }, { "id": "bf4e3061-2320-4077-b95f-2043f5752bb4", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bf4e3061-2320-4077-b95f-2043f5752bb4" }, { "id": "f64a2af8-4413-47cf-bd49-8346864a943b", "name": "The specified organization does not exist.", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f64a2af8-4413-47cf-bd49-8346864a943b" }, { "id": "02710487-76e7-4459-af1a-3782c7440dd7", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-02710487-76e7-4459-af1a-3782c7440dd7" }, { "id": "ba48ca7c-6244-43d4-b8b9-964708c55b2b", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ba48ca7c-6244-43d4-b8b9-964708c55b2b" }, { "id": "38592c03-4342-44ce-92f3-45f6e332705b", "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/organization/agent?deprecated=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "agent" ], "query": [ { "description": "Whether the agent is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of agents to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of agents.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-38592c03-4342-44ce-92f3-45f6e332705b" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2e2cbb7f-a97c-406b-bb2b-8123ad0789e4" } ], "id": "9e2500ce-cf09-48d7-a92a-763e6abaf755", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9e2500ce-cf09-48d7-a92a-763e6abaf755" }, { "name": "service_hierarchical_state_machine", "item": [ { "name": "{service_hierarchical_state_machine_id}", "item": [ { "name": "version", "item": [ { "name": "Get service hierarchical state machine versions", "id": "0982d52d-7aec-4e3d-97bc-978e86f3c83d", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "0cc880a9-309d-4acf-95b1-d0ec7eb263f3", "key": "organization", "value": "", "description": "(Required) " }, { "id": "2fbeb135-f01f-4969-bca8-c2ee8832c991", "key": "service_hierarchical_state_machine_id", "value": "8b1b652f5b1ef44301689c79", "description": "(Required) The ID of the state machine." } ] }, "description": "Retrieve the versions of a state machine.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:GetServiceHierarchicalStateMachine` for the state machine to retrieve." }, "response": [ { "id": "3b1a8324-2e58-42d8-9654-107d0f0e0714", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"state_machine_versions\": [\n {\n \"org_id\": \"\",\n \"service_hierarchical_state_machine_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"ephemeral\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"ephemeral\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"\",\n \"returning_user_initial_state\": \"\",\n \"terminal_state\": \"\",\n \"references\": {\n \"sed__\": \"\",\n \"aute_e\": \"\",\n \"auteb\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n },\n {\n \"org_id\": \"\",\n \"service_hierarchical_state_machine_id\": \"\",\n \"version\": \"\",\n \"created_at\": \"\",\n \"creator\": {\n \"org_id\": \"\",\n \"user_id\": \"\"\n },\n \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"\",\n \"objective\": \"\",\n \"actions\": [\n \"\",\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"ephemeral\"\n },\n {\n \"tool_id\": \"\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"ephemeral\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"\",\n \"returning_user_initial_state\": \"\",\n \"terminal_state\": \"\",\n \"references\": {\n \"eu_f\": \"\",\n \"non_3\": \"\",\n \"Excepteur_565\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3b1a8324-2e58-42d8-9654-107d0f0e0714" }, { "id": "850b062f-230e-4ed0-9aa8-6a7c0d475d7c", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-850b062f-230e-4ed0-9aa8-6a7c0d475d7c" }, { "id": "08633146-a12b-46c4-a97b-e6b06f0f2c41", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-08633146-a12b-46c4-a97b-e6b06f0f2c41" }, { "id": "04e0e18b-99d5-46bf-a7e6-eca5cdc8ac86", "name": "Specified organization or service hierarchical state machine 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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-04e0e18b-99d5-46bf-a7e6-eca5cdc8ac86" }, { "id": "84e34ec9-f658-4be7-93c1-ddd4f4b97a84", "name": "Invalid request path parameter or request 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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-84e34ec9-f658-4be7-93c1-ddd4f4b97a84" }, { "id": "a9874823-92bb-4d6f-8c89-f80f5c3744e9", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-a9874823-92bb-4d6f-8c89-f80f5c3744e9" }, { "id": "2a3900cb-9dc9-4821-b4f0-b58a76c5644f", "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/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/version?version=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "version" ], "query": [ { "description": "The versions of the state machine to retrieve. One can specify an exact version to retrieve, which is either the version number or `latest`, which retrieves the latest version. Alternatively, one can specify a range of inclusive lower and upper bound for the version number separated by `-`, and every version within the range would be retrieved.", "key": "version", "value": "" }, { "description": "The maximum number of state machine versions to return.", "key": "limit", "value": "10" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machine versions.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2a3900cb-9dc9-4821-b4f0-b58a76c5644f" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0982d52d-7aec-4e3d-97bc-978e86f3c83d" } ], "id": "78f6b18b-e2a8-4320-8573-ae7576216195", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-78f6b18b-e2a8-4320-8573-ae7576216195" }, { "name": "Create a service hierarchical state machine version", "id": "d60a3197-f2ca-47a7-8c90-cdef9d1629f9", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "id": "d648483a-fef0-43e1-a346-ca326c146d9d", "key": "organization", "value": "", "description": "(Required) " }, { "id": "f1445ec4-2d67-4d72-8c76-2c044b561788", "key": "service_hierarchical_state_machine_id", "value": "fed79526448a7562fde69762", "description": "(Required) The ID of the service hierarchical state machine to create a new version for." } ] }, "description": "Create a new version for the given service hierarchical state machine. The new version will be created with the supplied data. It needs to satisfy the following\nconstraints:\n* Each action state must have at least one action.\n* For action and decision states, each exit condition's `next_state` must either be a string that exists in the states and cannot be the same as the current state, or a 2-tuple of strings,\n with the first string of the form `{external_service_hierarchical_state_machine_reference.external_state_name}`, and the second string the jumpback state which must be a state\n in the states.\n* For `recall`, `reflection`, and `tool_call` states, `next_state` must either be a string that exists in the states and cannot be the same as the current state, or a 2-tuple of strings,\n with the first string of the form `{external_service_hierarchical_state_machine_reference.external_state_name}`, and the second string the jumpback state which must be a state\n in the states.\n* The terminal state cannot have exit conditions and must have exactly one action.\n\nSee the per-request-field documentation for more field-specific constraints.\n\nDue to the complexity of the state machine data structure, this endpoint provides a `dry_run` parameter. If set to `True`, the endpoint will check the supplied state machine would pass validations,\nbut does not actually create a new version. In this case, the endpoint returns an empty response with a 201 status code.\n\n#### Permissions:\nThis endpoint requires the following permissions:\n* `Organization:CreateServiceHierarchicalStateMachineVersion` for the service hierarchical state machine." }, "response": [ { "id": "d7e8e41b-a841-44b0-bab0-93bd297b9cfd", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": \"\",\n \"created_at\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-d7e8e41b-a841-44b0-bab0-93bd297b9cfd" }, { "id": "9bba06d7-f94b-43e2-b560-0881f2713711", "name": "The specified state machine version depends on another state machine that either doesn't exist or is deprecated", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9bba06d7-f94b-43e2-b560-0881f2713711" }, { "id": "2a9d7b43-6c1b-4bfb-97e6-2624cfa909ef", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2a9d7b43-6c1b-4bfb-97e6-2624cfa909ef" }, { "id": "f9b582d2-9c0f-47ce-ae52-ed0be2543a35", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f9b582d2-9c0f-47ce-ae52-ed0be2543a35" }, { "id": "96e4fcef-71a8-438d-a404-381ed9809f38", "name": "The specified organization, state machine, or tool does not exist.", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-96e4fcef-71a8-438d-a404-381ed9809f38" }, { "id": "8b3c80e6-04a0-4ede-bbca-f72667381abb", "name": "The specified version number is not the expected next version for the state machine.", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8b3c80e6-04a0-4ede-bbca-f72667381abb" }, { "id": "92e252f2-04ee-4b0b-9316-5b720c07c953", "name": "Invalid request path parameter, request body, or request query 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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-92e252f2-04ee-4b0b-9316-5b720c07c953" }, { "id": "ddadd282-74d7-4296-b4c6-a43e3793975a", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ddadd282-74d7-4296-b4c6-a43e3793975a" }, { "id": "fc615874-e167-42dd-bb56-37a5a942ac16", "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 \"description\": \"\",\n \"states\": [\n {\n \"type\": \"\",\n \"name\": \"JYMi\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"D6HVnP7h9\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"I92JvD\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"d3f562dd283cfbb4416fd5af\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"d7a9a24c9a95871848e85136\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"b057ef71f62fc9d74fa43677\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n },\n {\n \"tool_id\": \"9c8ed8e1321a9874cd8d648b\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n },\n {\n \"type\": \"\",\n \"name\": \"ffHQ7Xl\",\n \"objective\": \"\",\n \"actions\": [\n \"\"\n ],\n \"intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"action_guidelines\": [\n \"\",\n \"\"\n ],\n \"boundary_constraints\": [\n \"\",\n \"\"\n ],\n \"exit_conditions\": [\n {\n \"description\": \"\",\n \"next_state\": \"wxTCVuq\"\n },\n {\n \"description\": \"\",\n \"next_state\": \"lQJ8Q9Hd45Q\"\n }\n ],\n \"action_tool_call_specs\": [\n {\n \"tool_id\": \"e1fa915d0da31844131938de\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"e29cc8cd890360791e462cd7\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"exit_condition_tool_call_specs\": [\n {\n \"tool_id\": \"d39a97e4089764ca905ee553\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted-preferred\"\n },\n {\n \"tool_id\": \"cfcc933addb9463521ecbad1\",\n \"version_constraint\": \"\",\n \"additional_instruction\": \"\",\n \"audio_fillers\": [\n \"\",\n \"\"\n ],\n \"audio_filler_triggered_after\": \"\",\n \"result_persistence\": \"persisted\"\n }\n ],\n \"skip_active_memory_retrieval\": \"\"\n }\n ],\n \"new_user_initial_state\": \"6\",\n \"returning_user_initial_state\": \"9sxeY\",\n \"terminal_state\": \"ngXKS\",\n \"references\": {\n \"nostrud9e9\": \"\",\n \"aliquipb93\": \"\",\n \"quis71\": \"\",\n \"esse_9\": \"\"\n },\n \"global_intra_state_navigation_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_action_guidelines\": [\n \"\",\n \"\"\n ],\n \"global_boundary_constraints\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine/:service_hierarchical_state_machine_id/?version=&dry_run=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":service_hierarchical_state_machine_id", "" ], "query": [ { "description": "The version number of the new state machine version. If specified, this endpoint throws an error if the next version of the state machine in the database doesn't equal to the value of this parameter.", "key": "version", "value": "" }, { "description": "Whether to perform a dry run of the operation.", "key": "dry_run", "value": "false" } ], "variable": [ { "key": "organization" }, { "key": "service_hierarchical_state_machine_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-fc615874-e167-42dd-bb56-37a5a942ac16" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-d60a3197-f2ca-47a7-8c90-cdef9d1629f9" } ], "id": "9cc14c1c-3329-4fef-b8fa-7d0940a3008b", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9cc14c1c-3329-4fef-b8fa-7d0940a3008b" }, { "name": "{state_machine_id}", "item": [ { "name": "Delete a service hierarchical state machine", "id": "3007706a-2ea5-4230-96c1-18d3e46dfa8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "id": "b3166611-3990-4c26-b304-ce1e139c886d", "key": "organization", "value": "", "description": "(Required) " }, { "id": "a6aff66e-4962-40f1-8c8c-d444fe7294ac", "key": "state_machine_id", "value": "0d94cdb020cdcceac5e02fec", "description": "(Required) The ID of the state machine to delete" } ] }, "description": "Delete the specified state machine from the organization. In practice, this endpoint marks the state machine as deprecated, but will not delete\nthis state machine nor any of its versions. It does prevent new services (or inactive services to be activated) from using this state machine.\n\nAn error will be raised if this endpoint is called when an active service still utilizes this state machine. However, any ongoing conversation using this state machine,\nas well as any state machine version that depends on this state machine will continue to work.\n\n#### Permissions:\n* `Organization:DeleteServiceHierarchicalStateMachine` for the state machine to delete." }, "response": [ { "id": "5f42eaa1-d63a-4d3d-977a-5bcf5f8c2997", "name": "Succeeded.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5f42eaa1-d63a-4d3d-977a-5bcf5f8c2997" }, { "id": "36a925b4-ade4-4a4f-8c36-aeebd92202a4", "name": "An active service exists that utilizes this state machine.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-36a925b4-ade4-4a4f-8c36-aeebd92202a4" }, { "id": "bc019514-5918-41ab-8b64-9ac1c7eb8895", "name": "Invalid authorization credentials.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bc019514-5918-41ab-8b64-9ac1c7eb8895" }, { "id": "cd833df2-6b65-4dcf-8098-9fd4be8fd583", "name": "Missing required permissions.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-cd833df2-6b65-4dcf-8098-9fd4be8fd583" }, { "id": "04020e05-c06a-4a58-9049-09e052af1bfb", "name": "The specified organization or state machine does not exist.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-04020e05-c06a-4a58-9049-09e052af1bfb" }, { "id": "2ca008e8-2c17-423c-8aef-0620f7f5af8e", "name": "The specified state machine is already deleted", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-2ca008e8-2c17-423c-8aef-0620f7f5af8e" }, { "id": "122d4270-3a8c-415c-814c-6c962c653a8f", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-122d4270-3a8c-415c-814c-6c962c653a8f" }, { "id": "fb95a714-2fdc-422a-95f2-192558c6f7fc", "name": "The user has exceeded the rate limit of 10 requests per minute for this endpoint.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-fb95a714-2fdc-422a-95f2-192558c6f7fc" }, { "id": "918971e3-d486-4b87-9331-30dfa83df783", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "DELETE", "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/organization/service_hierarchical_state_machine/:state_machine_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine", ":state_machine_id", "" ], "variable": [ { "key": "organization" }, { "key": "state_machine_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-918971e3-d486-4b87-9331-30dfa83df783" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3007706a-2ea5-4230-96c1-18d3e46dfa8c" } ], "id": "21c3cc9b-6f1f-49dc-ae36-24d50f9363c4", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-21c3cc9b-6f1f-49dc-ae36-24d50f9363c4" }, { "name": "Create a service hierarchical state machine", "id": "0c612355-4334-41e8-bb83-5da2fb4c6f4f", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "id": "1c60061a-d021-4669-b2fd-d0340c2a8e28", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Create a new state machine for the given organization. No default version for the state machine will be created, so one must later create a version for this state machine so it can be used\nin a service.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:CreateServiceHierarchicalStateMachine` for the new service hierarchical state machine." }, "response": [ { "id": "54fb17c8-039d-442e-927c-71961c89ad91", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-54fb17c8-039d-442e-927c-71961c89ad91" }, { "id": "8c90df23-8ba4-406c-b925-e806798b3163", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8c90df23-8ba4-406c-b925-e806798b3163" }, { "id": "e89fbd7e-e7bf-4ccd-b1af-d55548ff63d8", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-e89fbd7e-e7bf-4ccd-b1af-d55548ff63d8" }, { "id": "6d43b216-728f-403f-bfbb-3a34b22ee749", "name": "The specified organization does not exist.", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-6d43b216-728f-403f-bfbb-3a34b22ee749" }, { "id": "b4da5325-4883-4226-a1c8-b5209a80a568", "name": "A state machine with the same name already exists.", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-b4da5325-4883-4226-a1c8-b5209a80a568" }, { "id": "acd6a345-a128-4103-b740-c439c40b4883", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-acd6a345-a128-4103-b740-c439c40b4883" }, { "id": "8ff2d0dd-c2f6-4bdd-b4f4-a4b28aa8e132", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8ff2d0dd-c2f6-4bdd-b4f4-a4b28aa8e132" }, { "id": "4b0c1192-f3be-492a-b76c-efc8b5241332", "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 \"state_machine_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/service_hierarchical_state_machine", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-4b0c1192-f3be-492a-b76c-efc8b5241332" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0c612355-4334-41e8-bb83-5da2fb4c6f4f" }, { "name": "Get service hierarchical state machines for an organization", "id": "fd6637dc-a68e-4ef7-a52c-6abd65829919", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "a2c5f797-6c50-4d18-9608-4fe58c40b64d", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Return a list of service hierarchical state machines for the organization.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* Only state machines that the authenticated user has the `Organization:GetServiceHierarchicalStateMachine` permission on will be returned." }, "response": [ { "id": "5228b291-5f02-4be2-8a74-4971861cc983", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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 \"service_hierarchical_state_machines\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"deprecated\": \"\",\n \"latest_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"deprecated\": \"\",\n \"latest_version\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5228b291-5f02-4be2-8a74-4971861cc983" }, { "id": "5c0616c8-75d6-446d-8f8f-6a0e00518b8a", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5c0616c8-75d6-446d-8f8f-6a0e00518b8a" }, { "id": "3b94b1c9-0e2e-4004-8e0f-e31d401e492d", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3b94b1c9-0e2e-4004-8e0f-e31d401e492d" }, { "id": "08ae4bb6-b771-4e4d-a3c4-b9c4cfa89e82", "name": "The specified organization does not exist.", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-08ae4bb6-b771-4e4d-a3c4-b9c4cfa89e82" }, { "id": "9b5b9550-93c3-4d7d-800e-28763a10958f", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9b5b9550-93c3-4d7d-800e-28763a10958f" }, { "id": "ff5e0080-785e-4e5d-bf68-e3e7ff2228e2", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ff5e0080-785e-4e5d-bf68-e3e7ff2228e2" }, { "id": "0ded3cc9-5de2-4d3e-86d4-9ee7ef9b6231", "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/organization/service_hierarchical_state_machine?deprecated=&limit=50&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "service_hierarchical_state_machine" ], "query": [ { "description": "Whether the state machine is deprecated.", "key": "deprecated", "value": "" }, { "description": "The maximum number of service hierarchical state machines to return.", "key": "limit", "value": "50" }, { "description": "The continuation token from the previous request used to retrieve the next page of state machines.", "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:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0ded3cc9-5de2-4d3e-86d4-9ee7ef9b6231" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-fd6637dc-a68e-4ef7-a52c-6abd65829919" } ], "id": "f7255a12-6368-4581-8d02-811a372736a8", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f7255a12-6368-4581-8d02-811a372736a8" }, { "name": "api_key", "item": [ { "name": "{api_key_id}", "item": [ { "name": "Delete an API key", "id": "48775fcd-18cb-4762-b500-62b6cf1fe271", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "id": "962c1225-106a-4c31-a43d-93e1d226236f", "key": "organization", "value": "", "description": "(Required) " }, { "id": "16da8dd0-9459-454a-a396-2f88a90d535d", "key": "api_key_id", "value": "", "description": "(Required) ID of the API key to delete." } ] }, "description": "Delete the given API key from this organization.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:DeleteAPIKey`." }, "response": [ { "id": "74b2459f-c4d0-4421-9f77-85826e4b2499", "name": "Succeeded.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"deleted_key_id\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-74b2459f-c4d0-4421-9f77-85826e4b2499" }, { "id": "50b53562-11b7-40a9-b379-993aa1ed4fd3", "name": "Invalid authorization credentials.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-50b53562-11b7-40a9-b379-993aa1ed4fd3" }, { "id": "a3da71d5-9cff-4302-ae1a-92ac71dca742", "name": "Missing required permissions.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-a3da71d5-9cff-4302-ae1a-92ac71dca742" }, { "id": "3517d8a4-d33c-46f0-90a3-e74acf661da8", "name": "The specified organization or the API key does not exist.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3517d8a4-d33c-46f0-90a3-e74acf661da8" }, { "id": "c38441fd-a18a-446f-b12a-7c76383711b9", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c38441fd-a18a-446f-b12a-7c76383711b9" }, { "id": "5f7b27ea-ffc6-48cb-9a28-d3b286e162fa", "name": "The user has exceeded the rate limit of 10 requests per minute for this endpoint.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5f7b27ea-ffc6-48cb-9a28-d3b286e162fa" }, { "id": "46bde3f8-2046-4c4e-a728-e1b0687593c2", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "DELETE", "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/organization/api_key/:api_key_id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", ":api_key_id", "" ], "variable": [ { "key": "organization" }, { "key": "api_key_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-46bde3f8-2046-4c4e-a728-e1b0687593c2" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-48775fcd-18cb-4762-b500-62b6cf1fe271" } ], "id": "50ddc079-e3d7-4837-a4f4-69cd816cf28b", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-50ddc079-e3d7-4837-a4f4-69cd816cf28b" }, { "name": "Create an API key", "id": "f9a3e41e-2ad7-4d79-a3bc-e8c5c545f10e", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "id": "5466b6a7-c353-432f-8e0b-f6b69e1d276e", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Create a new API key for the given organization. This API key authorizes the organization to retrieve a per-user access token for users in this organization which allows the users to access most of Amigo's API endpoints.\nThis API key is valid for the duration specified in the request. There's no way to extend the duration of an API key. The API key is not retrievable after issuance, so please keep it in a secure location.\n\nEach organization has a maximum limit of 20 API keys.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:CreateAPIKey`.\n* This endpoint requires the authenticated user to have more privileges than the role associated with the API key." }, "response": [ { "id": "9adc46f7-bd4d-4ccd-90e7-de4f8a62a210", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"api_key_id\": \"\",\n \"api_key\": \"\",\n \"expires_at\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9adc46f7-bd4d-4ccd-90e7-de4f8a62a210" }, { "id": "0ed56db3-a39e-4578-8697-dc5ef6f82efd", "name": "The organization has reached the maximum API key limit.", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0ed56db3-a39e-4578-8697-dc5ef6f82efd" }, { "id": "bce4842c-78cb-4cc0-ae65-b1aac39c3311", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-bce4842c-78cb-4cc0-ae65-b1aac39c3311" }, { "id": "4e3f436c-8d69-43fc-95a4-7712309e946e", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-4e3f436c-8d69-43fc-95a4-7712309e946e" }, { "id": "35a229ec-75f9-4964-a0ba-0406532b6964", "name": "The specified organization or role does not exist.", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-35a229ec-75f9-4964-a0ba-0406532b6964" }, { "id": "efe65555-f566-46b3-ae7d-ba3a34b976d3", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-efe65555-f566-46b3-ae7d-ba3a34b976d3" }, { "id": "45aea78b-9943-4152-9d71-d1968ec0c202", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-45aea78b-9943-4152-9d71-d1968ec0c202" }, { "id": "a9b02706-83ce-4e62-82b9-70ae30dbdced", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-a9b02706-83ce-4e62-82b9-70ae30dbdced" }, { "id": "c6213b46-9ff3-486d-91d1-822d0c791efd", "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 \"name\": \"\",\n \"duration\": \"\",\n \"role_name\": \"DefaultAdministratorRole\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c6213b46-9ff3-486d-91d1-822d0c791efd" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f9a3e41e-2ad7-4d79-a3bc-e8c5c545f10e" }, { "name": "Get API keys for the organization", "id": "dd386bbf-29d2-4ed1-be8d-cefc3174d221", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "id": "3277c340-fc02-457e-8c0e-938cbac130bd", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Get all API keys for the organization.\n\n#### Permissions\nThis endpoint is impacted by the following permissions:\n* Only API keys that the authenticated user has the `Organization:GetAPIKey` permission for are returned." }, "response": [ { "id": "e504d5ed-28d0-4f53-8e65-21e280d4a4a3", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"api_keys\": [\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"org_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key_id\": \"\",\n \"expires_at\": \"\",\n \"creator\": {\n \"user_id\": \"\",\n \"org_id\": \"\"\n },\n \"role_id\": \"\"\n },\n {\n \"_id\": \"\",\n \"name\": \"\",\n \"org_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key_id\": \"\",\n \"expires_at\": \"\",\n \"creator\": {\n \"user_id\": \"\",\n \"org_id\": \"\"\n },\n \"role_id\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-e504d5ed-28d0-4f53-8e65-21e280d4a4a3" }, { "id": "9cc72b79-40ba-4bec-8b12-90540f461a3a", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-9cc72b79-40ba-4bec-8b12-90540f461a3a" }, { "id": "97d70dd7-878e-4c0c-b3bc-ca78a471617f", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-97d70dd7-878e-4c0c-b3bc-ca78a471617f" }, { "id": "ad72c61a-8592-4904-ad4a-48f3fbad5bb6", "name": "The organization does not exist.", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ad72c61a-8592-4904-ad4a-48f3fbad5bb6" }, { "id": "0a5929fc-a9cd-4352-8dab-4561b2ae6e9d", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-0a5929fc-a9cd-4352-8dab-4561b2ae6e9d" }, { "id": "a9951b9a-c43e-45c3-b2f8-0fbf9e8123db", "name": "The user has exceeded the rate limit of 10 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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-a9951b9a-c43e-45c3-b2f8-0fbf9e8123db" }, { "id": "b650023d-55e0-4f60-87ba-400f74842b4d", "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/organization/api_key/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "api_key", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-b650023d-55e0-4f60-87ba-400f74842b4d" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-dd386bbf-29d2-4ed1-be8d-cefc3174d221" } ], "id": "31ff2265-f3a4-41d8-bf61-516d2b820ce6", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-31ff2265-f3a4-41d8-bf61-516d2b820ce6" }, { "name": "user_dimensions", "item": [ { "name": "Get user dimensions for the organization", "id": "3ce16b76-829c-48ce-a4c0-430f0124839a", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "id": "f5349ddd-0cff-4870-ad64-ce08218a98c2", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Get the list of user dimensions for the organization.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:GetOrganizationDetails` for the current organization." }, "response": [ { "id": "e5830c68-fed7-4604-afad-422112381faf", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-e5830c68-fed7-4604-afad-422112381faf" }, { "id": "17722b60-241b-4575-a898-666e7a2dc770", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-17722b60-241b-4575-a898-666e7a2dc770" }, { "id": "43ec43bc-b24a-4766-ba77-b16128520913", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-43ec43bc-b24a-4766-ba77-b16128520913" }, { "id": "61209533-ae15-4cac-ba9f-35c90a753a3d", "name": "The organization does not exist.", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-61209533-ae15-4cac-ba9f-35c90a753a3d" }, { "id": "3a916db1-b1be-4f10-8732-352fad628a6d", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3a916db1-b1be-4f10-8732-352fad628a6d" }, { "id": "f8b4800f-32c6-4b85-be80-fc30750c2856", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f8b4800f-32c6-4b85-be80-fc30750c2856" }, { "id": "d726f38a-acb2-436b-b1be-2c44a9eb0998", "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/organization/user_dimensions/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "user_dimensions", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-d726f38a-acb2-436b-b1be-2c44a9eb0998" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3ce16b76-829c-48ce-a4c0-430f0124839a" } ], "id": "368ed270-db71-494a-9292-6ce698bcbfae", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-368ed270-db71-494a-9292-6ce698bcbfae" }, { "name": "Get an organization", "id": "05b40bf6-a1fb-4c89-8fd9-e95526b1ad67", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "id": "7d733fc5-e78d-46da-b08c-56b84f6b5f58", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Get the details of an organization.\n\n#### Permissions\nThis endpoint may be impacted by the following permissions:\n* The `default_user_preferences` field is only populated if the endpoint is called with user authentication credentials, and the authenticated user has the\n`Organization:GetOrganizationDetails` permission." }, "response": [ { "id": "704207af-c710-49c0-9ef7-b61520716e4b", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"org_id\": \"\",\n \"org_name\": \"\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"\"\n },\n \"tenant_id\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-704207af-c710-49c0-9ef7-b61520716e4b" }, { "id": "d7066ddd-8c22-4f2a-94a7-31af819cec0b", "name": "The specified organization does not exist.", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-d7066ddd-8c22-4f2a-94a7-31af819cec0b" }, { "id": "80910d17-13aa-49d7-b01c-575c8d2a6db9", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-80910d17-13aa-49d7-b01c-575c8d2a6db9" }, { "id": "ef58f641-811c-40fb-8d5f-738ffc9d06e4", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ef58f641-811c-40fb-8d5f-738ffc9d06e4" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-05b40bf6-a1fb-4c89-8fd9-e95526b1ad67" }, { "name": "Create an organization", "id": "aa4d42e0-694c-4424-8973-a396559fce46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "id": "41ad407c-c0ec-4e48-a4fa-f8f2457216c7", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Set up a new organization in the Amigo system. Specifically, it\n* creates a new organization within the Amigo Mongo database with the given details.\n * Along with the new organization, 4 default roles are created:\n * `DefaultUserRole`.\n * `DefaultAdministratorRole`.\n * `DefaultAmigoAdministratorRole`.\n * `DefaultSuperAdministratorRole`.\n * A super user, `admin@amigo.ai`, is created and granted the `DefaultSuperAdministratorRole`.\n* creates a new tenant in Google Identity Platform for users in this organization.\n* creates a new Route53 record, `{org_id}.amigo.ai`, that hosts the Amigo frontend for this organization.\n* creates a new domain, `{org_id}.amigo.ai`, on Vercel.\n\nThe `x-mongo-cluster-name` header is mandatory for this endpoint.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:CreateOrganization`. for the organization to create." }, "response": [ { "id": "caf3e1df-1f65-4cf7-8c48-edbbf6717af3", "name": "Succeeded.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"org_id\": \"\"\n}", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-caf3e1df-1f65-4cf7-8c48-edbbf6717af3" }, { "id": "35344c0a-3aeb-401a-8b0e-a5bb13140536", "name": "The specified organization ID is reserved.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-35344c0a-3aeb-401a-8b0e-a5bb13140536" }, { "id": "3364722c-bb4c-4ae7-bfee-9478ca0f64fb", "name": "Invalid authorization credentials.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3364722c-bb4c-4ae7-bfee-9478ca0f64fb" }, { "id": "a9cab1c5-729a-4fba-b053-74a4cbfec54f", "name": "Missing required permissions.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-a9cab1c5-729a-4fba-b053-74a4cbfec54f" }, { "id": "554af33b-ac97-4190-8cc6-2566477feee6", "name": "Conflicts with existing organization with the same `org_id`, or a related operation is in progress.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-554af33b-ac97-4190-8cc6-2566477feee6" }, { "id": "3f57bf98-b709-4043-9e9f-23b282de7dc9", "name": "Invalid request path parameter or request body failed validation.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-3f57bf98-b709-4043-9e9f-23b282de7dc9" }, { "id": "c11ee8a7-e791-45c6-a076-12fa99016d9c", "name": "The user has exceeded the rate limit of 5 requests per minute for this endpoint.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-c11ee8a7-e791-45c6-a076-12fa99016d9c" }, { "id": "329a830f-42dd-4cf3-8506-f2354712e69f", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The Mongo cluster name to perform this request in.", "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 \"org_name\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"azure_devops_team_name\": \"no-purtxv\",\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"bwb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"Asia/Irkutsk\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-329a830f-42dd-4cf3-8506-f2354712e69f" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-aa4d42e0-694c-4424-8973-a396559fce46" }, { "name": "Modify an organization", "id": "ecd1916b-7db1-4a48-a855-09eacde03b4d", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "id": "d828b75b-49ea-487e-9b1b-b5b67664c005", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Modify elements of an organization.\n\n#### Permissions\nThis endpoint requries the following permissions:\n* `Organization:ModifyOrganization` to modify the organization." }, "response": [ { "id": "23cdc18f-5976-4398-8590-2c5cf200bf10", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-23cdc18f-5976-4398-8590-2c5cf200bf10" }, { "id": "f71f92ed-277e-4903-bead-082aaf024338", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f71f92ed-277e-4903-bead-082aaf024338" }, { "id": "82a271fa-de53-4da7-a495-425597494ead", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-82a271fa-de53-4da7-a495-425597494ead" }, { "id": "398df590-95cd-419a-b732-d28422001a6a", "name": "The specified organization does not exist.", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-398df590-95cd-419a-b732-d28422001a6a" }, { "id": "05700dcb-efcd-41b2-b25a-7411a0d9b383", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-05700dcb-efcd-41b2-b25a-7411a0d9b383" }, { "id": "7e51961f-33f4-4bcb-9471-97e84fb96218", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-7e51961f-33f4-4bcb-9471-97e84fb96218" }, { "id": "918e3474-32ea-4001-8aa4-faeaa8bc9b72", "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 \"logo\": \"\",\n \"square_logo\": \"\",\n \"favicon\": \"\",\n \"user_dimensions\": [\n {\n \"description\": \"\",\n \"tags\": [\n \"\"\n ]\n }\n ],\n \"default_user_preferences\": {\n \"enable_response_recommendation\": false,\n \"preferred_language\": \"glb\",\n \"conversations_visible_to_admins\": true,\n \"user_model_visible_to_admins\": true,\n \"timezone\": \"America/Curacao\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:organization/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-918e3474-32ea-4001-8aa4-faeaa8bc9b72" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ecd1916b-7db1-4a48-a855-09eacde03b4d" }, { "name": "Delete an organization", "id": "d9b07517-0a9a-4544-bb15-06ad63dad526", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "id": "b3d64ae7-abd1-4592-b42d-db8e8ae3a6fe", "key": "organization", "value": "", "description": "(Required) " } ] }, "description": "Delete an organization. All of the organization's data are erased. Some analytical data will be asynchronously removed at\na future date.\n\nUnlike other endpoints, this endpoint is not transactional. If any operation fails during the execution, the endpoint does not\nrevert the performed actions. The caller should re-call this endpoint until it succeeds.\n\nRegardless of whether this endpoint succeeds or not, the first time this endpoint is called, the organization is considered\ndeleted. Even if the endpoint fails and the organization isn't completely wiped, it's considered in an invalid state and any\nother operations on it may fail.\n\n#### Permissions\nThis endpoint requires the following permissions:\n* `Organization:DeleteOrganization` for the organization to delete." }, "response": [ { "id": "5682acff-a636-41b9-a912-a2a4a816a2ca", "name": "Succeeded.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-5682acff-a636-41b9-a912-a2a4a816a2ca" }, { "id": "ccaf33ec-eddb-4b58-8840-2c31314ad695", "name": "The current environment or organization does not support this endpoint.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ccaf33ec-eddb-4b58-8840-2c31314ad695" }, { "id": "f54409ae-e398-42aa-9273-7d6c29c42467", "name": "Invalid authorization credentials.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-f54409ae-e398-42aa-9273-7d6c29c42467" }, { "id": "ea24bd21-823c-43f2-a1ec-34e20833be34", "name": "Missing required permissions.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-ea24bd21-823c-43f2-a1ec-34e20833be34" }, { "id": "280af16c-3e5d-4770-9ebd-ce768364172b", "name": "Specified organization is not found.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-280af16c-3e5d-4770-9ebd-ce768364172b" }, { "id": "100f73b9-3606-4195-a3d1-ee2d4c06e873", "name": "A related operation is in progress.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-100f73b9-3606-4195-a3d1-ee2d4c06e873" }, { "id": "6c963bec-151f-4a9d-9e46-76a2a872c024", "name": "Invalid request path parameter failed validation.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-6c963bec-151f-4a9d-9e46-76a2a872c024" }, { "id": "33815a1d-d6b1-4b28-8ed8-8a657bb58b21", "name": "The user has exceeded the rate limit of 5 requests per minute for this endpoint.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-33815a1d-d6b1-4b28-8ed8-8a657bb58b21" }, { "id": "aeb632df-8a13-48e4-ac43-3f961e2135ce", "name": "The service is going through temporary maintenance.", "originalRequest": { "method": "DELETE", "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/organization/", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":organization", "organization", "" ], "variable": [ { "key": "organization" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-aeb632df-8a13-48e4-ac43-3f961e2135ce" } ], "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-d9b07517-0a9a-4544-bb15-06ad63dad526" } ], "id": "34d7f295-5882-4ee5-9008-a12e0b23f569", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-34d7f295-5882-4ee5-9008-a12e0b23f569" } ], "id": "fd322610-718a-4e52-8767-8abc75b69712", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-fd322610-718a-4e52-8767-8abc75b69712" } ], "id": "8f018754-27ae-4ce3-a0e1-b12c36855d11", "createdAt": "2026-07-28T01:01:40.000Z", "updatedAt": "2026-07-28T01:01:40.000Z", "uid": "35240-8f018754-27ae-4ce3-a0e1-b12c36855d11" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.amigo.ai" } ] }