{ "openapi": "3.1.0", "info": { "title": "ConverSimple platform API", "version": "1.1.0", "description": "Management, realtime admission and results. New platform management requires CONVERSIMPLE_PLATFORM_API=1; headless/rooms retain their independent flags. Media uses Phoenix/WebRTC SDKs, not HTTP. This specification describes implemented source; query capabilities on your deployment." }, "servers": [ { "url": "https://api.conversimple.com" } ], "security": [ { "customerBearer": [] } ], "paths": { "/api/v1/agents": { "get": { "summary": "List agents", "description": "Retrieve a paginated list of all agents for the authenticated customer.\nResults are sorted by updated_at (newest first).\n", "operationId": "agents_Agent_list", "tags": [ "agents" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination (starts at 1)", "schema": { "type": "integer", "default": 1, "minimum": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "status", "in": "query", "description": "Filter by agent status", "schema": { "type": "string", "enum": [ "draft", "published", "archived" ] } }, { "name": "search", "in": "query", "description": "Search agents by name (partial match)", "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Successful response with list of agents", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Agent" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "post": { "summary": "Create agent", "description": "Supply name and agent_spec for a validated synchronous draft (201), or name and description for an asynchronous generation job (202). Do not supply credentials in model instructions.", "operationId": "agents_Agent_create", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateRequest" } } } }, "responses": { "202": { "description": "Generation queued; poll returned meta.polling_url", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "job_id": { "oneOf": [ { "type": [ "string", "null" ] }, { "type": [ "integer", "null" ] } ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ValidationError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "201": { "description": "Direct-spec draft created", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Agent" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ] } }, "/api/v1/agents/{id}": { "get": { "summary": "Get agent details", "description": "Retrieve detailed information about a specific agent.", "operationId": "agents_Agent_show", "tags": [ "agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Agent details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Agent" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "put": { "summary": "Update agent", "description": "Update an existing agent's properties.", "operationId": "agents_Agent_update", "tags": [ "agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdateRequest" } } } }, "responses": { "200": { "description": "Agent updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Agent" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "422": { "$ref": "#/components/responses/ValidationError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "delete": { "summary": "Delete agent", "description": "Delete an agent (soft delete - archives the agent).", "operationId": "agents_Agent_delete", "tags": [ "agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Agent deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "Agent deleted successfully" } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/agents/{id}/spec": { "get": { "summary": "Get agent specification", "description": "Retrieve the current working specification for an agent.", "operationId": "agents_Agent_get_spec", "tags": [ "agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Agent specification", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "description": "Agent spec (functions, instructions, etc.)" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/agents/{id}/publish": { "post": { "summary": "Publish agent", "description": "Publish an agent to make it available for deployment.", "operationId": "agents_Agent_publish", "tags": [ "agents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Agent published successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Agent" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentPublishRequest" } } } } } }, "/api/v1/deployments": { "get": { "summary": "List deployments", "description": "Retrieve a paginated list of all deployments for the authenticated customer.", "operationId": "deployments_Deployment_list", "tags": [ "deployments" ], "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "schema": { "type": "integer", "default": 20, "maximum": 100 } }, { "name": "agent_id", "in": "query", "description": "Filter by specific agent", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "description": "Filter by deployment status", "schema": { "type": "string", "enum": [ "pending", "active", "failed", "inactive" ] } }, { "name": "environment", "in": "query", "description": "Filter by environment", "schema": { "type": "string", "enum": [ "dev", "staging", "prod", "widget" ] } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Successful response with list of deployments", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deployment" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "post": { "summary": "Create deployment", "description": "Create a new deployment for an agent.", "operationId": "deployments_Deployment_create", "tags": [ "deployments" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "agent_id", "environment" ], "properties": { "agent_id": { "type": "string", "format": "uuid", "description": "ID of the agent to deploy" }, "environment": { "type": "string", "enum": [ "dev", "staging", "prod", "widget" ], "description": "Deployment environment" }, "call_direction": { "type": "string", "enum": [ "inbound", "outbound", "both" ], "default": "inbound", "description": "Call direction capability" }, "engagement_rules": { "type": "object", "description": "Engagement rules configuration" }, "channel_config": { "type": "object", "description": "Channel-specific configuration" } } } } } }, "responses": { "201": { "description": "Deployment created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Deployment" } } } } } }, "400": { "$ref": "#/components/responses/BadRequestError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "description": "Agent not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Agent not found or access denied" } } } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ] } }, "/api/v1/deployments/{id}": { "get": { "summary": "Get deployment details", "description": "Retrieve detailed information about a specific deployment.", "operationId": "deployments_Deployment_show", "tags": [ "deployments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Deployment details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Deployment" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "put": { "summary": "Update deployment", "description": "Update deployment configuration.", "operationId": "deployments_Deployment_update", "tags": [ "deployments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "call_direction": { "type": "string", "enum": [ "inbound", "outbound", "both" ] }, "engagement_rules": { "type": "object" }, "channel_config": { "type": "object" } } } } } }, "responses": { "200": { "description": "Deployment updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Deployment" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } }, "delete": { "summary": "Delete deployment", "description": "Delete a deployment.", "operationId": "deployments_Deployment_delete", "tags": [ "deployments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Deployment deleted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "Deployment deleted successfully" } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/deployments/{id}/activate": { "post": { "summary": "Activate deployment", "description": "Activate a deployment to start using it.", "operationId": "deployments_Deployment_activate", "tags": [ "deployments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Deployment activated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Deployment" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/deployments/{id}/deactivate": { "post": { "summary": "Deactivate deployment", "description": "Deactivate a deployment to stop using it.", "operationId": "deployments_Deployment_deactivate", "tags": [ "deployments" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Deployment deactivated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#/components/schemas/Deployment" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/settings/api-key": { "get": { "summary": "Get current API key info", "description": "Retrieve information about the current API key (masked).", "operationId": "settings_ApiKey_get_current_key", "tags": [ "settings" ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "Current API key information", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "key_prefix": { "type": "string", "description": "Masked API key (e.g., cs_abc123...xyz789)", "example": "cs_abc123...789" }, "created_at": { "type": "string", "format": "date-time" }, "last_used_at": { "type": [ "string", "null" ], "format": "date-time" }, "customer_id": { "type": "string", "format": "uuid" }, "email": { "type": "string" } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "parameters": [] } }, "/api/v1/settings/api-key/rotate": { "post": { "summary": "Rotate API key", "description": "Generate a new API key and invalidate the old one.\n\n**Important**: The new key is returned only once. Save it securely!\n", "operationId": "settings_ApiKey_rotate_key", "tags": [ "settings" ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "API key rotated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "new_key": { "type": "string", "description": "New API key (save this securely!)", "example": "cs_new_key_here_very_long_string" }, "created_at": { "type": "string", "format": "date-time" }, "message": { "type": "string", "example": "API key rotated successfully. Save the new key now!" } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "parameters": [] } }, "/api/v1/settings/api-key/usage": { "get": { "summary": "Get API key usage stats", "description": "Retrieve usage statistics for the current API key.", "operationId": "settings_ApiKey_get_usage", "tags": [ "settings" ], "security": [ { "customerBearer": [] } ], "responses": { "200": { "description": "API key usage statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object", "properties": { "last_activity_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_activity_ago_seconds": { "type": "integer", "description": "Seconds since last API activity", "example": 1800 }, "status": { "type": "string", "enum": [ "active", "suspended", "inactive" ] }, "billing_tier": { "type": "string", "example": "pro" }, "usage_credits_seconds": { "type": "integer", "description": "Remaining usage credits in seconds" } } } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "403": { "$ref": "#/components/responses/ForbiddenError" }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "parameters": [] } }, "/api/v1/sessions": { "post": { "summary": "Create asynchronous session", "parameters": [], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Erased interaction cannot be recreated; select a new interaction reference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSession" } } } }, "x-milestone": "M0", "operationId": "sessions_ApplicationSession_create", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}": { "get": { "summary": "Inspect own session", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M0", "operationId": "sessions_ApplicationSession_show", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] }, "delete": { "summary": "Stop and revoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M0", "operationId": "sessions_ApplicationSession_delete", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/participants/{participant_id}/credentials": { "post": { "summary": "Issue or rotate unused client credential", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientConnection" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M0", "operationId": "sessions_ApplicationSession_credentials", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/participants/{participant_id}": { "delete": { "summary": "Revoke participant", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "const": "revoked" } } } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M0", "operationId": "sessions_ApplicationSession_revoke", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/events": { "get": { "summary": "Read durable lifecycle log", "parameters": [ { "name": "after", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M2", "operationId": "sessions_ApplicationSession_events", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/events/ack": { "post": { "summary": "Acknowledge durably processed event cursor (does not delete data)", "x-milestone": "M2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventAckRequest" } } } }, "responses": { "200": { "description": "Monotonic acknowledged cursor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventAckResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown/cross-tenant session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or cross-session cursor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "operationId": "sessions_ApplicationSession_acknowledge", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/utterances": { "post": { "summary": "Ordered Concierge output operations (trusted backend only)", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputOperation" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputResponse" } } } }, "401": { "description": "Invalid server credential" }, "403": { "description": "Speaking/proactive permission denied" }, "409": { "description": "Stale generation/turn, conflict or ordering violation" }, "422": { "description": "Unsupported provider/invalid operation/unavailable session" }, "429": { "description": "Backpressure or output limit" }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "operationId": "sessions_ApplicationSession_output", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms": { "post": { "summary": "Create inference-free shared room", "parameters": [], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Erased interaction cannot be recreated; select a new interaction reference", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoom" } } } }, "operationId": "rooms_ApplicationRoom_create", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}": { "get": { "summary": "Inspect owned room", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationRoom_show", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] }, "delete": { "summary": "End room and revoke all participants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "status": { "const": "ended" } }, "required": [ "status" ] } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationRoom_delete", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants": { "post": { "summary": "Add human membership", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomParticipantResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRoomHuman" } } } }, "operationId": "rooms_ApplicationRoom_add_participant", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}/credentials": { "post": { "summary": "Detach previous media and issue fresh scoped credential", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomConnection" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationRoom_credentials", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}/disconnect": { "post": { "summary": "Disconnect media without removing membership", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "status": { "const": "disconnected" } }, "required": [ "status" ] } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationRoom_disconnect", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}": { "delete": { "summary": "Revoke participant and remove media", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "status": { "const": "removed" } }, "required": [ "status" ] } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationRoom_remove", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}/listening": { "put": { "summary": "Replace explicit same-room listening grants", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomParticipantResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "participant_ids": { "type": "array", "maxItems": 16, "items": { "type": "string", "format": "uuid" } } }, "required": [ "participant_ids" ] } } } }, "operationId": "rooms_ApplicationRoom_listening", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}/mute": { "put": { "summary": "Set server mute independently of self mute", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomParticipantResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "muted": { "type": "boolean" } }, "required": [ "muted" ] } } } }, "operationId": "rooms_ApplicationRoom_mute", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/participants/{participant_id}/transcription": { "put": { "summary": "Set explicit human transcription consent; no STT in human-only rooms", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomParticipantResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Room/participant/customer capacity exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4 human-only", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "allowed": { "type": "boolean" } }, "required": [ "allowed" ] } } } }, "operationId": "rooms_ApplicationRoom_transcription", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/events": { "get": { "summary": "Read durable lifecycle log", "parameters": [ { "name": "after", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Inactive customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown or cross-tenant resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or unavailable participant", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M2", "operationId": "rooms_ApplicationSession_events", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/events/ack": { "post": { "summary": "Acknowledge durably processed event cursor (does not delete data)", "x-milestone": "M2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventAckRequest" } } } }, "responses": { "200": { "description": "Monotonic acknowledged cursor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventAckResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "404": { "description": "Unknown/cross-tenant session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Invalid or cross-session cursor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "operationId": "rooms_ApplicationSession_acknowledge", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/agents": { "post": { "summary": "Add independently configured External Concierge agent to existing shared room", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomParticipantResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddRoomAgent" } } } }, "operationId": "rooms_ApplicationRoom_add_agent", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/agents/{participant_id}/utterances": { "post": { "summary": "Control output of an authorized independently scoped room AI", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "participant_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomOutputOperation" } } } }, "operationId": "rooms_ApplicationRoom_output", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/rooms/{id}/content-erasure": { "post": { "summary": "Erase ended session private content; queue recording deletion, retain explicit accounting tombstone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentErasureResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationErasure_create", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] }, "get": { "summary": "Read content erasure receipt and pending recording object count", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentErasureResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; human media independently qualified; AI requires separate feature flag and compatible published Concierge deployment", "operationId": "rooms_ApplicationErasure_show", "tags": [ "rooms" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/sessions/{id}/content-erasure": { "post": { "summary": "Erase ended session private content; queue recording deletion, retain explicit accounting tombstone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentErasureResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; feature-gated, frozen integration handoff pending", "operationId": "sessions_ApplicationErasure_create", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] }, "get": { "summary": "Read content erasure receipt and pending recording object count", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentErasureResponse" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; feature-gated, frozen integration handoff pending", "operationId": "sessions_ApplicationErasure_show", "tags": [ "sessions" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/capabilities": { "get": { "summary": "Read feature availability for this server; deployment compatibility remains required", "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Capabilities" } } } }, "401": { "description": "Invalid server credential", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } }, "403": { "description": "Permission denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown, cross-tenant or feature disabled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Busy, active, stale or unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Incompatible or invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity, resource or backpressure limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-milestone": "M4/M5", "x-availability": "Development; feature-gated, frozen integration handoff pending", "operationId": "capabilities_ApplicationCapabilities_show", "tags": [ "capabilities" ], "security": [ { "customerBearer": [] } ] } }, "/api/v1/platform-capabilities": { "get": { "operationId": "platform_capabilities_Credentials_capabilities", "summary": "Capabilities platform-capabilities", "tags": [ "platform-capabilities" ], "security": [ { "customerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "contract_version": { "type": [ "string", "null" ] }, "openapi_path": { "type": [ "string", "null" ] }, "docs_path": { "type": [ "string", "null" ] }, "scoped_credentials": { "type": "boolean" }, "webhook_delivery": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/jobs/{id}/status": { "get": { "operationId": "jobs_Jobs_show", "summary": "Show jobs", "tags": [ "jobs" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Job" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/signing-keys": { "get": { "operationId": "signing_keys_Credentials_signing_keys", "summary": "Signing keys signing-keys", "tags": [ "signing-keys" ], "security": [ { "customerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/SigningKeys" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/api-keys": { "get": { "operationId": "api_keys_Credentials_index", "summary": "Index api-keys", "tags": [ "api-keys" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/APICredential" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "api_keys_Credentials_create", "summary": "Create api-keys", "tags": [ "api-keys" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialCreateRequest" } } } }, "parameters": [], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/CredentialCreated" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/api-keys/{id}": { "delete": { "operationId": "api_keys_Credentials_delete", "summary": "Delete api-keys", "tags": [ "api-keys" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/environments/test/credits": { "post": { "operationId": "environments_Credentials_fund", "summary": "Fund environments", "tags": [ "environments" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentCreditsRequest" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "environment": { "type": [ "string", "null" ] }, "transferred_credit_seconds": { "type": [ "integer", "null" ] }, "available_credit_seconds": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/environments": { "post": { "operationId": "environments_Credentials_environment", "summary": "Environment environments", "tags": [ "environments" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentCreateRequest" } } } }, "parameters": [], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "customer_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/webhooks": { "get": { "operationId": "webhooks_Webhooks_index", "summary": "Index webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "webhooks_Webhooks_create", "summary": "Create webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateRequest" } } } }, "parameters": [], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/WebhookCreated" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/webhooks/{id}": { "delete": { "operationId": "webhooks_Webhooks_delete", "summary": "Delete webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/webhooks/{id}/rotate-secret": { "post": { "operationId": "webhooks_Webhooks_rotate", "summary": "Rotate webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/WebhookCreated" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/webhooks/{id}/deliveries": { "get": { "operationId": "webhooks_Webhooks_deliveries", "summary": "Deliveries webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/webhooks/{id}/replay": { "post": { "operationId": "webhooks_Webhooks_replay", "summary": "Replay webhooks", "tags": [ "webhooks" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookReplayRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/WebhookDelivery" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools": { "get": { "operationId": "tools_Tools_index", "summary": "Index tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tool" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "tools_Tools_create", "summary": "Create tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolCreateRequest" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Tool" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools/import": { "post": { "operationId": "tools_Tools_import", "summary": "Import tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolImportRequest" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tool" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools/{id}": { "get": { "operationId": "tools_Tools_show", "summary": "Show tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Tool" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "put": { "operationId": "tools_Tools_update", "summary": "Update tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolUpdateRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Tool" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "delete": { "operationId": "tools_Tools_delete", "summary": "Delete tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools/{id}/test": { "post": { "operationId": "tools_Tools_test", "summary": "Test tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolArgumentsRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "request": { "type": "object" }, "response": { "type": "object" } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools/{id}/simulate": { "post": { "operationId": "tools_Tools_simulate", "summary": "Simulate tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolArgumentsRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "simulated": { "const": true }, "result": { "type": "object" } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tools/{id}/simulation": { "put": { "operationId": "tools_Tools_simulation", "summary": "Simulation tools", "tags": [ "tools" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSimulationRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "tool_id": { "type": [ "string", "null" ], "format": "uuid" }, "payload": { "type": "object" } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/tools": { "get": { "operationId": "agents_Tools_assignments", "summary": "Assignments agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ToolAssignment" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "agents_Tools_assign", "summary": "Assign agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolAssignmentRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ToolAssignment" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/tools/{tool_id}/{intent_name}": { "delete": { "operationId": "agents_Tools_unassign", "summary": "Unassign agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "intent_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/validation": { "get": { "operationId": "agents_Tools_validation", "summary": "Validation agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/AgentValidation" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/draft": { "put": { "operationId": "agents_Tools_draft", "summary": "Draft agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDraftRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "draft_spec": { "type": "object" }, "published_version": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/draft/publish": { "post": { "operationId": "agents_Tools_publish_draft", "summary": "Publish draft agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "version": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/versions": { "get": { "operationId": "agents_Tools_versions", "summary": "Versions agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentVersion" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/agents/{id}/rollback": { "post": { "operationId": "agents_Tools_rollback", "summary": "Rollback agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRollbackRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "version": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/integrations/{provider}/authorize": { "post": { "operationId": "integrations_OAuth_authorize", "summary": "Authorize integrations", "tags": [ "integrations" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "authorization_url": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/integrations/{provider}": { "delete": { "operationId": "integrations_OAuth_disconnect", "summary": "Disconnect integrations", "tags": [ "integrations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "provider": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tool-secrets": { "get": { "operationId": "tool_secrets_ToolSecrets_index", "summary": "Index tool-secrets", "tags": [ "tool-secrets" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ToolSecret" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "tool_secrets_ToolSecrets_create", "summary": "Create tool-secrets", "tags": [ "tool-secrets" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolSecretCreateRequest" } } } }, "parameters": [], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ToolSecret" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/tool-secrets/{id}": { "delete": { "operationId": "tool_secrets_ToolSecrets_delete", "summary": "Delete tool-secrets", "tags": [ "tool-secrets" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/integrations": { "get": { "operationId": "integrations_Tools_integrations", "summary": "Integrations integrations", "tags": [ "integrations" ], "security": [ { "customerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/integrations/{provider}/tools": { "post": { "operationId": "integrations_Tools_materialize", "summary": "Materialize integrations", "tags": [ "integrations" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationToolRequest" } } } }, "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Tool" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases": { "get": { "operationId": "knowledge_bases_Knowledge_index", "summary": "Index knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeCollection" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "knowledge_bases_Knowledge_create", "summary": "Create knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeCreateRequest" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeCollection" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases/{id}": { "get": { "operationId": "knowledge_bases_Knowledge_show", "summary": "Show knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeCollection" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "put": { "operationId": "knowledge_bases_Knowledge_update", "summary": "Update knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeUpdateRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeCollection" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "delete": { "operationId": "knowledge_bases_Knowledge_delete", "summary": "Delete knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases/{id}/documents": { "get": { "operationId": "knowledge_bases_Knowledge_documents", "summary": "Documents knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeSource" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "post": { "operationId": "knowledge_bases_Knowledge_add_document", "summary": "Add document knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeSourceRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeSource" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases/{id}/documents/{document_id}": { "get": { "operationId": "knowledge_bases_Knowledge_document", "summary": "Document knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeSource" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "delete": { "operationId": "knowledge_bases_Knowledge_delete_document", "summary": "Delete document knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases/{id}/documents/{document_id}/reprocess": { "post": { "operationId": "knowledge_bases_Knowledge_reprocess", "summary": "Reprocess knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptyRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "202": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/KnowledgeSource" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/knowledge-bases/{id}/query": { "post": { "operationId": "knowledge_bases_Knowledge_query", "summary": "Query knowledge-bases", "tags": [ "knowledge-bases" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeQueryRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeMatch" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations": { "get": { "operationId": "conversations_Conversations_index", "summary": "Index conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformConversation" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations/{id}": { "get": { "operationId": "conversations_Conversations_show", "summary": "Show conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/PlatformConversation" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations/{id}/transcript": { "get": { "operationId": "conversations_Conversations_transcript", "summary": "Transcript conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Transcript" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations/{id}/outcome": { "get": { "operationId": "conversations_Conversations_outcome", "summary": "Outcome conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ApplicationOutcome" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" }, "put": { "operationId": "conversations_Conversations_put_outcome", "summary": "Put outcome conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationOutcomeRequest" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": "24-hour identical-body mutation/result replay. External actions require application-owned deduplication." } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ApplicationOutcome" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations/{id}/recordings": { "get": { "operationId": "conversations_Conversations_recordings", "summary": "Recordings conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Recording" } }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/conversations/{id}/recordings/{turn_id}": { "get": { "operationId": "conversations_Conversations_recording", "summary": "Recording conversations", "tags": [ "conversations" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "turn_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/usage": { "get": { "operationId": "usage_Conversations_usage", "summary": "Usage usage", "tags": [ "usage" ], "security": [ { "customerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/Usage" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-feature-flag": "CONVERSIMPLE_PLATFORM_API" } }, "/api/v1/voice/offerings": { "get": { "operationId": "voice_Agent_voice_offerings", "summary": "Voice offerings voice", "tags": [ "voice" ], "security": [ { "customerBearer": [] } ], "parameters": [], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/v1/agents/{id}/generation-status": { "get": { "operationId": "agents_Agent_generation_status", "summary": "Generation status agents", "tags": [ "agents" ], "security": [ { "customerBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "401": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "403": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "404": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "409": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "413": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "422": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "429": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "503": { "description": "API error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }, "/api/oauth/{provider}/callback": { "get": { "operationId": "OAuth_callback", "summary": "Complete an API-initiated provider consent flow", "tags": [ "integrations" ], "security": [], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "hubspot", "slack", "salesforce" ] } }, { "name": "state", "in": "query", "required": true, "schema": { "type": [ "string", "null" ] } }, { "name": "code", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Connected; provider credentials remain server-side", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "object", "properties": { "provider": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true }, "meta": { "type": "object", "properties": { "page": { "type": [ "integer", "null" ] }, "per_page": { "type": [ "integer", "null" ] }, "total_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": true } }, "required": [ "success", "data" ], "additionalProperties": true } } } }, "422": { "description": "Invalid/expired/consumed state or failed consent" } } } } }, "components": { "securitySchemes": { "customerBearer": { "type": "http", "scheme": "bearer", "description": "Server-side root or scoped credential. Never expose to a mobile/browser end user." } }, "schemas": { "Agent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "name": { "type": "string", "example": "Support Bot" }, "status": { "type": "string", "enum": [ "draft", "published", "archived" ], "example": "published" }, "version": { "type": "integer", "example": 2 }, "agent_spec": { "type": "object", "description": "Agent specification containing functions and configuration" }, "draft_spec": { "type": [ "object", "null" ] }, "generated_spec": { "type": [ "object", "null" ] }, "test_mode_enabled": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "project_id": { "type": "string", "format": "uuid" }, "knowledge_base_id": { "type": [ "string", "null" ], "format": "uuid" } } }, "Deployment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "789e0123-f45c-67d8-e901-234567890abc" }, "agent_id": { "type": "string", "format": "uuid" }, "environment": { "type": "string", "enum": [ "dev", "staging", "prod", "widget" ], "example": "prod" }, "status": { "type": "string", "enum": [ "pending", "active", "failed", "inactive" ], "example": "active" }, "call_direction": { "type": "string", "enum": [ "inbound", "outbound", "both" ], "example": "both" }, "engagement_rules": { "type": "object", "description": "Engagement configuration rules" }, "channel_config": { "type": "object", "description": "Channel-specific configuration" }, "runtime_config": { "type": "object", "description": "Runtime configuration" }, "deployed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "agent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "integer" } } } } }, "PaginationMeta": { "type": "object", "properties": { "page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 20 }, "total_count": { "type": "integer", "example": 150 }, "total_pages": { "type": "integer", "example": 8 } } }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" } } } } }, "CreateSession": { "type": "object", "additionalProperties": false, "required": [ "application_id", "actor_id", "interaction_id", "deployment_id", "adapter", "tool_mode" ], "properties": { "application_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "actor_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "interaction_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "deployment_id": { "type": "string", "format": "uuid" }, "adapter": { "enum": [ "native_sts", "standard", "external_concierge" ] }, "tool_mode": { "enum": [ "http", "sdk" ] }, "context": { "type": "object", "description": "Maximum 16384 encoded JSON bytes" }, "policy": { "type": "object", "additionalProperties": false, "properties": { "recording": { "type": "boolean", "default": false }, "export_transcripts": { "type": "boolean", "default": false }, "max_duration_seconds": { "type": "integer", "minimum": 30, "maximum": 3600, "default": 900 }, "proactive_speech": { "type": "boolean", "default": false } } }, "voice": { "type": "object", "additionalProperties": false, "properties": { "stt_provider": { "type": "string" }, "tts_provider": { "type": "string" }, "sts_provider": { "type": "string" }, "languages": { "type": "array", "maxItems": 10, "items": { "type": "string" } }, "stt_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] } } }, "tts_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] } } }, "sts_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] }, "proactive_audio": { "type": "boolean", "description": "Explicit Gemini 2.5 native-audio model response-discretion override; false prioritizes responses in an intentional active call." }, "start_of_speech_sensitivity": { "type": "string", "enum": [ "low", "high" ] }, "end_of_speech_sensitivity": { "type": "string", "enum": [ "low", "high" ] }, "prefix_padding_ms": { "type": "integer", "minimum": 0, "maximum": 1000 }, "silence_duration_ms": { "type": "integer", "minimum": 200, "maximum": 2000 } } } } } } }, "Participant": { "type": "object", "required": [ "id", "external_id", "kind", "capabilities", "revoked" ], "properties": { "id": { "type": "string", "format": "uuid" }, "external_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "kind": { "enum": [ "human", "ai" ] }, "capabilities": { "type": "array", "items": { "enum": [ "listen", "speak", "control" ] } }, "revoked": { "type": "boolean" } } }, "Session": { "type": "object", "required": [ "id", "application_id", "actor_id", "interaction_id", "deployment_id", "agent_id", "agent_version", "adapter", "tool_mode", "status", "failure_code", "acknowledged_sequence", "conversation_id", "expires_at", "participants", "usage" ], "properties": { "id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "actor_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "interaction_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "deployment_id": { "type": "string", "format": "uuid" }, "agent_id": { "type": "string", "format": "uuid" }, "agent_version": { "type": [ "integer", "null" ], "minimum": 0 }, "adapter": { "enum": [ "native_sts", "standard", "external_concierge" ] }, "tool_mode": { "enum": [ "http", "sdk" ] }, "status": { "enum": [ "starting", "active", "ended", "failed" ] }, "failure_code": { "type": [ "string", "null" ] }, "acknowledged_sequence": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "expires_at": { "type": "string", "format": "date-time", "description": "Session wall-clock deadline; ISO8601, unlike credential expires_at." }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/Participant" } }, "usage": { "type": "object", "required": [ "duration_seconds", "total_tokens", "accounting" ], "properties": { "duration_seconds": { "type": [ "integer", "null" ], "minimum": 0 }, "total_tokens": { "type": [ "integer", "null" ], "minimum": 0 }, "accounting": { "type": "string", "description": "Observed counters, not provider invoice costs." } } } } }, "SessionResponse": { "type": "object", "required": [ "session" ], "properties": { "session": { "$ref": "#/components/schemas/Session" } } }, "IceServer": { "type": "object", "required": [ "urls" ], "properties": { "urls": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "username": { "type": "string" }, "credential": { "type": "string" } } }, "ClientConnection": { "type": "object", "required": [ "schema_version", "session_id", "conversation_id", "participant_id", "room_id", "join_token", "expires_at", "signaling_path", "transport", "ice_servers", "ice_transport_policy" ], "properties": { "schema_version": { "const": "1" }, "session_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "participant_id": { "type": "string", "format": "uuid" }, "room_id": { "type": "string", "format": "uuid" }, "join_token": { "type": "string", "description": "Opaque single-use socket admission credential. Never parse as JWT or log." }, "expires_at": { "type": "integer", "description": "Unix seconds (UTC)" }, "signaling_path": { "enum": [ "/socket", "/application_socket" ] }, "transport": { "const": "webrtc" }, "ice_servers": { "type": "array", "items": { "$ref": "#/components/schemas/IceServer" } }, "ice_transport_policy": { "enum": [ "all", "relay" ] } } }, "ApplicationEvent": { "type": "object", "required": [ "id", "schema_version", "sequence", "session_id", "type", "occurred_at", "payload" ], "properties": { "id": { "type": "string", "format": "uuid" }, "schema_version": { "const": "1" }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 }, "session_id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "session.created", "session.ready", "session.failed", "session.ended", "session.runtime_state", "session.runtime_ended", "participant.added", "participant.muted", "participant.listening_changed", "participant.transcription_consent_changed", "session.content_erased", "participant.input_delivered", "usage.agent", "agent.execution_ended", "agent.failed", "participant.transport_lost", "participant.negotiation_failed", "usage.media", "participant.joined", "participant.left", "participant.removed", "transcript.finalized", "transcript.agent_generated", "transcript.agent_finalized", "utterance.audio_available", "utterance.output_accepted", "utterance.provider_completed", "utterance.interrupted", "utterance.playback_acknowledged", "utterance.initiated", "utterance.started", "utterance.completed", "utterance.cancelled", "utterance.failed", "utterance.audio_submitted", "reasoning.requested", "reasoning.accepted", "reasoning.cancelled", "reasoning.failed", "tool.requested", "tool.completed", "tool.failed", "tool.cancelled", "tool.timed_out" ] }, "occurred_at": { "type": "string", "format": "date-time" }, "payload": { "type": "object", "description": "Allowlisted per-type metadata. Transcript text only when export_transcripts was enabled at write time; no tool args/results or memory.", "additionalProperties": true } } }, "EventPage": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "maxItems": 100, "items": { "$ref": "#/components/schemas/ApplicationEvent" } } } }, "EventAckRequest": { "type": "object", "required": [ "sequence" ], "properties": { "sequence": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } } }, "EventAckResponse": { "type": "object", "required": [ "acknowledged_sequence" ], "properties": { "acknowledged_sequence": { "type": "integer", "minimum": 0, "maximum": 9223372036854775807 } } }, "AuthError": { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "const": false }, "error": { "type": "string" } } }, "ExecutionContext": { "type": "object", "required": [ "schema_version", "customer_id", "application_id", "session_id", "conversation_id", "external_actor_id", "external_interaction_id", "agent_id", "agent_version", "invocation_id", "call_id", "tool_name", "turn_reference", "policy", "expires_at", "deadline_at" ], "properties": { "schema_version": { "const": "1" }, "customer_id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "session_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "external_actor_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "external_interaction_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "agent_id": { "type": "string", "format": "uuid" }, "agent_version": { "type": [ "integer", "null" ], "minimum": 0 }, "invocation_id": { "type": "string", "format": "uuid" }, "call_id": { "type": "string", "maxLength": 256 }, "tool_name": { "type": "string", "maxLength": 128 }, "turn_reference": { "type": [ "string", "null" ], "description": "Server conversational counter reference; generation UUID lifecycle comes in M3." }, "policy": { "type": "object", "additionalProperties": false, "properties": { "recording": { "type": "boolean", "default": false }, "export_transcripts": { "type": "boolean", "default": false }, "max_duration_seconds": { "type": "integer", "minimum": 30, "maximum": 3600, "default": 900 } } }, "expires_at": { "type": "integer", "description": "Unix seconds (UTC)" }, "deadline_at": { "type": "integer", "description": "Unix seconds (UTC)" } } }, "SignedHttpExecutionContext": { "allOf": [ { "$ref": "#/components/schemas/ExecutionContext" }, { "type": "object", "required": [ "request_method", "request_url", "body_sha256", "issued_at" ], "properties": { "request_method": { "type": "string", "description": "Lowercase HTTP method" }, "request_url": { "type": "string", "format": "uri" }, "body_sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "issued_at": { "type": "integer", "description": "Unix seconds (UTC)" } } } ] }, "ConciergeContext": { "type": "object", "required": [ "schema_version", "session_id", "customer_id", "application_id", "agent_id", "external_actor_id", "external_interaction_id", "approved_context", "policy" ], "properties": { "schema_version": { "const": "1" }, "session_id": { "type": "string", "format": "uuid" }, "customer_id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "agent_id": { "type": "string", "format": "uuid" }, "external_actor_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "external_interaction_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "approved_context": { "type": "object" }, "policy": { "type": "object", "additionalProperties": false, "properties": { "recording": { "type": "boolean", "default": false }, "export_transcripts": { "type": "boolean", "default": false }, "max_duration_seconds": { "type": "integer", "minimum": 30, "maximum": 3600, "default": 900 }, "proactive_speech": { "type": "boolean", "default": false } } } } }, "ConciergeRequest": { "type": "object", "required": [ "conversation_id", "turn_id", "trace_id", "external_user_id", "transcript", "timestamp" ], "properties": { "conversation_id": { "type": "string", "format": "uuid" }, "turn_id": { "type": "string", "format": "uuid" }, "trace_id": { "type": "string", "format": "uuid" }, "external_user_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "transcript": { "type": "string", "x-max-utf8-bytes": 16000 }, "timestamp": { "type": "string", "format": "date-time" }, "execution_context": { "oneOf": [ { "allOf": [ { "$ref": "#/components/schemas/ConciergeContext" }, { "not": { "required": [ "session_topology" ] } } ] }, { "$ref": "#/components/schemas/RoomConciergeContext" } ] } } }, "ConciergeCompleteReply": { "type": "object", "required": [ "conversation_id", "turn_id", "reply_text" ], "properties": { "conversation_id": { "type": "string", "format": "uuid" }, "turn_id": { "type": "string", "format": "uuid" }, "reply_text": { "type": "string", "minLength": 1, "x-max-utf8-bytes": 16000 } } }, "ConciergeAcceptedReply": { "type": "object", "required": [ "conversation_id", "turn_id", "status" ], "properties": { "conversation_id": { "type": "string", "format": "uuid" }, "turn_id": { "type": "string", "format": "uuid" }, "status": { "const": "accepted" } } }, "SDKToolRequest": { "type": "object", "required": [ "call_id", "conversation_id", "tool_name", "arguments", "timeout_seconds", "timestamp", "execution_context" ], "properties": { "call_id": { "type": "string" }, "conversation_id": { "type": "string", "format": "uuid" }, "tool_name": { "type": "string" }, "arguments": { "type": "object" }, "timeout_seconds": { "type": "integer" }, "timestamp": { "type": "string", "format": "date-time" }, "execution_context": { "oneOf": [ { "$ref": "#/components/schemas/ExecutionContext" }, { "type": "null", "description": "Legacy non-headless conversations only." } ] } } }, "OutputOperation": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "begin" }, "utterance_id": { "type": "string", "format": "uuid" }, "participant_id": { "type": "string", "format": "uuid" }, "mode": { "enum": [ "response", "proactive" ] }, "turn_id": { "type": "string", "format": "uuid" }, "incremental": { "type": "boolean", "default": false }, "queue_policy": { "const": "reject_if_busy", "default": "reject_if_busy" } }, "required": [ "operation", "utterance_id", "participant_id", "mode" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "append" }, "utterance_id": { "type": "string", "format": "uuid" }, "generation_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 128 }, "text": { "type": "string", "description": "1\u20132048 UTF-8 bytes, total <=16000 bytes per utterance" } }, "required": [ "operation", "utterance_id", "generation_id", "sequence", "text" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "enum": [ "complete", "cancel" ] }, "utterance_id": { "type": "string", "format": "uuid" }, "generation_id": { "type": "string", "format": "uuid" } }, "required": [ "operation", "utterance_id", "generation_id" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "cancel_turn" }, "turn_id": { "type": "string", "format": "uuid" } }, "required": [ "operation", "turn_id" ] } ] }, "Utterance": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "generation_id": { "type": "string", "format": "uuid" }, "participant_id": { "type": "string" }, "turn_id": { "type": [ "string", "null" ] }, "status": { "enum": [ "output_accepted", "speaking", "completed", "cancelled", "interrupted", "failed" ] }, "next_sequence": { "type": "integer" }, "input_complete": { "type": "boolean" }, "duplicate": { "type": "boolean" } }, "required": [ "id", "generation_id", "participant_id", "turn_id", "status", "next_sequence", "input_complete" ] }, "OutputResponse": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "utterance": { "$ref": "#/components/schemas/Utterance" } }, "required": [ "utterance" ] }, { "type": "object", "additionalProperties": false, "properties": { "utterance": { "type": "object", "additionalProperties": false, "properties": { "turn_id": { "type": "string", "format": "uuid" }, "status": { "const": "cancelled" } }, "required": [ "turn_id", "status" ] } }, "required": [ "utterance" ] } ] }, "RoomPolicy": { "type": "object", "additionalProperties": false, "properties": { "max_duration_seconds": { "type": "integer", "minimum": 30, "maximum": 3600, "default": 900 }, "recording": { "const": false }, "export_transcripts": { "type": "boolean" }, "proactive_speech": { "type": "boolean" }, "ai_to_ai_input": { "type": "boolean", "default": false, "description": "Explicit opt-in to completed-utterance text routing among authorized AI listeners, never self-echo STT." } }, "required": [] }, "CreateRoom": { "type": "object", "additionalProperties": false, "properties": { "application_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "actor_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "interaction_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "max_participants": { "type": "integer", "minimum": 2, "maximum": 16, "default": 8 }, "policy": { "$ref": "#/components/schemas/RoomPolicy" } }, "required": [ "application_id", "actor_id", "interaction_id" ] }, "AddRoomHuman": { "type": "object", "additionalProperties": false, "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "capabilities": { "type": "array", "items": { "enum": [ "listen", "speak", "control" ] } }, "context": { "type": "object", "description": "Private server-owned JSON <=16 KiB; never exposed in participant DTO." }, "transcription_allowed": { "type": "boolean", "default": false } }, "required": [ "external_id" ] }, "RoomParticipant": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "external_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "kind": { "enum": [ "human", "ai" ] }, "capabilities": { "type": "array", "items": { "type": "string" } }, "muted": { "type": "boolean" }, "server_muted": { "type": "boolean" }, "listening_to": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "revoked": { "type": "boolean" }, "joined_at": { "type": [ "string", "null" ], "format": "date-time" }, "left_at": { "type": [ "string", "null" ], "format": "date-time" }, "media_seconds": { "type": "integer", "minimum": 0 }, "transcription_allowed": { "type": "boolean" }, "execution_status": { "type": [ "string", "null" ] }, "deployment_id": { "type": [ "string", "null" ], "format": "uuid" }, "execution_conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "resource_limits": { "$ref": "#/components/schemas/AgentExecutionLimits" } }, "required": [ "id", "external_id", "kind", "capabilities", "muted", "server_muted", "listening_to", "revoked", "joined_at", "left_at", "media_seconds", "transcription_allowed", "execution_status", "deployment_id", "execution_conversation_id", "resource_limits" ] }, "Room": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "topology": { "const": "room" }, "application_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "actor_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "interaction_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "status": { "enum": [ "starting", "active", "ended", "failed" ] }, "failure_code": { "type": [ "string", "null" ] }, "max_participants": { "type": "integer" }, "expires_at": { "type": "string", "format": "date-time" }, "recording": { "const": false }, "acknowledged_sequence": { "type": "integer" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/RoomParticipant" } }, "usage": { "type": "object", "additionalProperties": false, "properties": { "human_media_seconds": { "type": "integer", "minimum": 0 }, "accounting": { "type": "string" } }, "required": [ "human_media_seconds", "accounting" ] } }, "required": [ "id", "topology", "application_id", "actor_id", "interaction_id", "status", "failure_code", "max_participants", "expires_at", "recording", "acknowledged_sequence", "participants", "usage" ] }, "RoomResponse": { "type": "object", "additionalProperties": false, "properties": { "room": { "$ref": "#/components/schemas/Room" } }, "required": [ "room" ] }, "RoomParticipantResponse": { "type": "object", "additionalProperties": false, "properties": { "participant": { "$ref": "#/components/schemas/RoomParticipant" } }, "required": [ "participant" ] }, "RoomConnection": { "type": "object", "additionalProperties": false, "properties": { "schema_version": { "const": "1" }, "topology": { "const": "room" }, "session_id": { "type": "string", "format": "uuid" }, "participant_id": { "type": "string", "format": "uuid" }, "room_id": { "type": "string", "format": "uuid" }, "join_token": { "type": "string" }, "expires_at": { "type": "integer" }, "signaling_path": { "const": "/application_socket" }, "transport": { "const": "webrtc" }, "ice_servers": { "type": "array", "items": { "$ref": "#/components/schemas/IceServer" } }, "ice_transport_policy": { "enum": [ "all", "relay" ] } }, "required": [ "schema_version", "topology", "session_id", "participant_id", "room_id", "join_token", "expires_at", "signaling_path", "transport", "ice_servers", "ice_transport_policy" ] }, "AgentExecutionLimits": { "type": "object", "additionalProperties": false, "properties": { "max_utterances": { "type": "integer", "minimum": 1, "maximum": 256, "default": 64 }, "max_text_bytes": { "type": "integer", "minimum": 1, "maximum": 1000000, "default": 128000 }, "max_audio_seconds": { "type": "integer", "minimum": 1, "maximum": 3600, "default": 300 }, "max_reasoning_turns": { "type": "integer", "minimum": 1, "maximum": 256, "default": 64 }, "max_utterance_seconds": { "type": "integer", "minimum": 1, "maximum": 120, "default": 60 } }, "required": [] }, "AddRoomAgent": { "type": "object", "additionalProperties": false, "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "deployment_id": { "type": "string", "format": "uuid" }, "adapter": { "const": "external_concierge" }, "tool_mode": { "const": "http" }, "context": { "type": "object", "x-max-json-utf8-bytes": 16384 }, "voice": { "type": "object", "additionalProperties": false, "properties": { "stt_provider": { "type": "string" }, "tts_provider": { "type": "string" }, "sts_provider": { "type": "string" }, "languages": { "type": "array", "maxItems": 10, "items": { "type": "string" } }, "stt_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] } } }, "tts_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] } } }, "sts_provider_config": { "type": "object", "additionalProperties": false, "properties": { "model": { "type": [ "string", "number" ] }, "model_id": { "type": [ "string", "number" ] }, "voice": { "type": [ "string", "number" ] }, "voice_id": { "type": [ "string", "number" ] }, "voice_name": { "type": [ "string", "number" ] }, "speaker": { "type": [ "string", "number" ] }, "language": { "type": [ "string", "number" ] }, "target_language_code": { "type": [ "string", "number" ] }, "speaking_rate": { "type": [ "string", "number" ] }, "speed": { "type": [ "string", "number" ] }, "pitch": { "type": [ "string", "number" ] }, "proactive_audio": { "type": "boolean", "description": "Explicit Gemini 2.5 native-audio model response-discretion override; false prioritizes responses in an intentional active call." }, "start_of_speech_sensitivity": { "type": "string", "enum": [ "low", "high" ] }, "end_of_speech_sensitivity": { "type": "string", "enum": [ "low", "high" ] }, "prefix_padding_ms": { "type": "integer", "minimum": 0, "maximum": 1000 }, "silence_duration_ms": { "type": "integer", "minimum": 200, "maximum": 2000 } } } } }, "resource_limits": { "$ref": "#/components/schemas/AgentExecutionLimits" } }, "required": [ "external_id", "deployment_id", "adapter", "tool_mode" ] }, "RoomConciergeContext": { "type": "object", "required": [ "schema_version", "session_id", "customer_id", "application_id", "agent_id", "external_actor_id", "external_interaction_id", "approved_context", "policy", "session_topology", "agent_participant_id", "external_character_id", "resource_limits" ], "properties": { "schema_version": { "const": "1" }, "session_id": { "type": "string", "format": "uuid" }, "customer_id": { "type": "string", "format": "uuid" }, "application_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "agent_id": { "type": "string", "format": "uuid" }, "external_actor_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "external_interaction_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "approved_context": { "type": "object" }, "policy": { "$ref": "#/components/schemas/RoomPolicy" }, "session_topology": { "const": "room" }, "agent_version": { "type": [ "integer", "null" ] }, "agent_participant_id": { "type": "string", "format": "uuid" }, "external_character_id": { "type": "string", "minLength": 1, "maxLength": 256, "x-max-utf8-bytes": 256 }, "input_participant_id": { "type": "string", "format": "uuid" }, "input_participant_kind": { "enum": [ "human", "ai" ] }, "input_provenance": { "enum": [ "stt", "agent_utterance_text" ] }, "resource_limits": { "$ref": "#/components/schemas/AgentExecutionLimits" } } }, "RoomOutputOperation": { "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "begin" }, "utterance_id": { "type": "string", "format": "uuid" }, "mode": { "enum": [ "response", "proactive" ] }, "turn_id": { "type": "string", "format": "uuid" }, "incremental": { "type": "boolean", "default": false }, "queue_policy": { "const": "reject_if_busy", "default": "reject_if_busy" } }, "required": [ "operation", "utterance_id", "mode" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "append" }, "utterance_id": { "type": "string", "format": "uuid" }, "generation_id": { "type": "string", "format": "uuid" }, "sequence": { "type": "integer", "minimum": 1, "maximum": 128 }, "text": { "type": "string", "description": "1\u20132048 UTF-8 bytes, total <=16000 bytes per utterance" } }, "required": [ "operation", "utterance_id", "generation_id", "sequence", "text" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "enum": [ "complete", "cancel" ] }, "utterance_id": { "type": "string", "format": "uuid" }, "generation_id": { "type": "string", "format": "uuid" } }, "required": [ "operation", "utterance_id", "generation_id" ] }, { "type": "object", "additionalProperties": false, "properties": { "operation": { "const": "cancel_turn" }, "turn_id": { "type": "string", "format": "uuid" } }, "required": [ "operation", "turn_id" ] } ] }, "ContentErasureReceipt": { "type": "object", "additionalProperties": false, "properties": { "session_id": { "type": "string", "format": "uuid" }, "scope": { "const": "content" }, "content_erased_at": { "type": [ "string", "null" ], "format": "date-time" }, "recordings": { "enum": [ "not_requested", "pending", "erased_or_absent" ] }, "pending_recording_objects": { "type": "integer", "minimum": 0 }, "retained": { "type": "array", "items": { "type": "string" } }, "external_copies": { "type": "string" } }, "required": [ "session_id", "scope", "content_erased_at", "recordings", "pending_recording_objects", "retained", "external_copies" ] }, "ContentErasureResponse": { "type": "object", "additionalProperties": false, "properties": { "erasure": { "$ref": "#/components/schemas/ContentErasureReceipt" } }, "required": [ "erasure" ] }, "Capabilities": { "type": "object", "additionalProperties": false, "properties": { "schema_version": { "const": "1" }, "contract_version": { "const": "1.0.0-dev.m5" }, "requires_published_compatible_deployment": { "const": true }, "content_erasure": { "type": "boolean" }, "voice": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "adapters": { "type": "array", "items": { "enum": [ "native_sts", "standard", "external_concierge" ] } }, "transports": { "type": "array", "items": { "const": "webrtc" } } }, "required": [ "enabled", "adapters", "transports" ] }, "rooms": { "type": "object", "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "human_only": { "type": "boolean" }, "recording": { "const": false }, "agent_adapters": { "type": "array", "items": { "const": "external_concierge" } }, "multiple_ai": { "type": "boolean" }, "ai_input_requires_opt_in": { "const": true }, "speech_queue_policy": { "const": "reject_if_busy" } }, "required": [ "enabled", "human_only", "recording", "agent_adapters", "multiple_ai", "ai_input_requires_opt_in", "speech_queue_policy" ] }, "integration": { "type": "object", "additionalProperties": false, "properties": { "event_transport": { "const": "durable_poll" }, "output": { "const": "completed_text_and_ordered_segments" }, "incremental_provider": { "const": "deepgram" } }, "required": [ "event_transport", "output", "incremental_provider" ] } }, "required": [ "schema_version", "contract_version", "requires_published_compatible_deployment", "content_erasure", "voice", "rooms", "integration" ] }, "PlatformError": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "oneOf": [ { "type": [ "string", "null" ] }, { "type": "object", "properties": { "code": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true } ] }, "request_id": { "type": [ "string", "null" ] }, "details": { "type": "object" } }, "required": [ "error" ], "additionalProperties": true }, "Tool": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "slug": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "scope": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "executor_type": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "integration_type": { "type": [ "string", "null" ] }, "integration_reference": { "type": [ "string", "null" ] }, "endpoint": { "type": [ "string", "null" ] }, "method": { "type": [ "string", "null" ] }, "inserted_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "id": { "type": [ "string", "null" ], "format": "uuid" }, "input_schema": { "type": "object" }, "output_schema": { "type": "object" }, "readiness": { "type": "object", "properties": { "ready": { "type": "boolean" }, "message": { "type": [ "string", "null" ] }, "verification": { "const": "configuration_only" } }, "required": [], "additionalProperties": true } }, "required": [ "id", "name", "executor_type", "readiness" ], "additionalProperties": true }, "ToolAssignment": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "agent_id": { "type": [ "string", "null" ], "format": "uuid" }, "tool_id": { "type": [ "string", "null" ], "format": "uuid" }, "intent_name": { "type": [ "string", "null" ] }, "enabled": { "type": "boolean" }, "metadata": { "type": "object" } }, "required": [ "id", "agent_id", "tool_id", "intent_name", "enabled" ], "additionalProperties": true }, "KnowledgeCollection": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "default_language": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "customer_id": { "type": [ "string", "null" ], "format": "uuid" }, "inserted_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "status" ], "additionalProperties": true }, "KnowledgeSource": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "knowledge_base_id": { "type": [ "string", "null" ], "format": "uuid" }, "title": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "processing", "ready", "failed" ] }, "content_type": { "type": [ "string", "null" ] }, "source_bytes": { "type": [ "integer", "null" ] }, "processing_error": { "type": [ "string", "null" ] }, "inserted_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "status" ], "additionalProperties": true }, "KnowledgeMatch": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "document_id": { "type": [ "string", "null" ], "format": "uuid" }, "content": { "type": [ "string", "null" ] }, "metadata": { "type": "object" } }, "required": [ "id", "document_id", "content" ], "additionalProperties": true }, "APICredential": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "environment": { "type": "string", "enum": [ "live", "test" ] }, "prefix": { "type": [ "string", "null" ] }, "scopes": { "type": "array", "items": { "type": [ "string", "null" ] } }, "requests_per_minute": { "type": [ "integer", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "revoked_at": { "type": [ "string", "null" ] }, "last_used_at": { "type": [ "string", "null" ] }, "inserted_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "environment", "prefix", "scopes", "requests_per_minute" ], "additionalProperties": true }, "CredentialCreated": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "environment": { "type": [ "string", "null" ] }, "prefix": { "type": [ "string", "null" ] }, "scopes": { "type": "array", "items": { "type": [ "string", "null" ] } }, "requests_per_minute": { "type": [ "integer", "null" ] }, "key": { "type": [ "string", "null" ] } }, "required": [ "id", "key" ], "additionalProperties": true }, "Webhook": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "url": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": { "type": [ "string", "null" ] } }, "enabled": { "type": "boolean" }, "inserted_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "url", "events", "enabled" ], "additionalProperties": true }, "WebhookCreated": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "url": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": { "type": [ "string", "null" ] } }, "enabled": { "type": "boolean" }, "signing_secret": { "type": [ "string", "null" ] } }, "required": [ "id", "signing_secret" ], "additionalProperties": true }, "WebhookDelivery": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "event_sequence": { "type": [ "integer", "null" ] }, "status": { "type": "string", "enum": [ "pending", "delivering", "delivered", "failed", "cancelled" ] }, "attempts": { "type": [ "integer", "null" ] }, "http_status": { "type": [ "integer", "null" ] }, "last_attempt_at": { "type": [ "string", "null" ] }, "inserted_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "event_sequence", "status", "attempts" ], "additionalProperties": true }, "PlatformConversation": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "agent_id": { "type": [ "string", "null" ], "format": "uuid" }, "deployment_id": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": [ "string", "null" ] }, "mode": { "type": [ "string", "null" ] }, "call_direction": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ] }, "ended_at": { "type": [ "string", "null" ] }, "content_erased_at": { "type": [ "string", "null" ] }, "inserted_at": { "type": [ "string", "null" ] }, "duration_seconds": { "type": [ "integer", "null" ] }, "audio_duration_seconds": { "type": [ "integer", "null" ] }, "processing_duration_seconds": { "type": [ "integer", "null" ] }, "total_tokens_used": { "type": [ "integer", "null" ] }, "error_count": { "type": [ "integer", "null" ] } }, "required": [ "id", "status" ], "additionalProperties": true }, "Transcript": { "type": "object", "properties": { "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "text": { "type": [ "string", "null" ] }, "turns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "role": { "type": [ "string", "null" ] }, "turn_index": { "type": [ "integer", "null" ] }, "transcript": { "type": [ "string", "null" ] }, "started_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": true } }, "stage": { "const": "recorded_or_generated_not_heard" } }, "required": [ "conversation_id", "turns", "stage" ], "additionalProperties": true }, "ApplicationOutcome": { "type": "object", "properties": { "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": [ "string", "null" ] }, "ended_at": { "type": [ "string", "null" ] }, "application_result": { "type": [ "object", "null" ] }, "source": { "const": "application_or_lifecycle" } }, "required": [ "conversation_id", "status", "source" ], "additionalProperties": true }, "Usage": { "type": "object", "properties": { "conversations": { "type": [ "integer", "null" ] }, "duration_seconds": { "type": [ "integer", "null" ] }, "audio_duration_seconds": { "type": [ "integer", "null" ] }, "processing_duration_seconds": { "type": [ "integer", "null" ] }, "observed_model_tokens": { "type": [ "integer", "null" ] }, "source": { "const": "application_observed" }, "provider_invoice": { "const": false }, "cost": { "type": "null" } }, "required": [ "conversations", "duration_seconds", "observed_model_tokens", "source", "provider_invoice", "cost" ], "additionalProperties": true }, "Job": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "attempt": { "type": [ "integer", "null" ] }, "max_attempts": { "type": [ "integer", "null" ] }, "resource_id": { "type": [ "string", "null" ] }, "resource_type": { "const": "agent" }, "error_code": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "completed_at": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "attempt", "max_attempts", "resource_type" ], "additionalProperties": true }, "AgentVersion": { "type": "object", "properties": { "version": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "configuration": { "type": "object" } }, "required": [ "version", "configuration" ], "additionalProperties": true }, "AgentValidation": { "type": "object", "properties": { "voice_errors": { "type": "array", "items": { "type": "object" } }, "unconfigured_tools": { "type": "array", "items": { "type": [ "string", "null" ] } }, "tools": { "type": "array", "items": { "$ref": "#/components/schemas/Tool" } }, "knowledge_base_id": { "type": [ "string", "null" ], "format": "uuid" }, "network_verified": { "const": false } }, "required": [ "voice_errors", "tools", "network_verified" ], "additionalProperties": true }, "Integration": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "hubspot", "salesforce", "slack" ] }, "status": { "type": [ "string", "null" ] }, "scopes": { "type": "array", "items": { "type": [ "string", "null" ] } }, "templates": { "type": "array", "items": { "type": "object" } }, "verification": { "const": "configuration_only" } }, "required": [ "provider", "status", "scopes", "templates", "verification" ], "additionalProperties": true }, "Recording": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "role": { "type": [ "string", "null" ] }, "turn_index": { "type": [ "integer", "null" ] }, "audio_format": { "type": [ "string", "null" ] }, "audio_bytes": { "type": [ "integer", "null" ] }, "audio_duration_ms": { "type": [ "integer", "null" ] } }, "required": [ "id", "role", "turn_index" ], "additionalProperties": true }, "ToolSecret": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "credential_id": { "type": [ "string", "null" ] } }, "required": [ "id", "credential_id" ], "additionalProperties": true }, "SigningKeys": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "kty": { "const": "OKP" }, "crv": { "const": "Ed25519" }, "alg": { "const": "EdDSA" }, "use": { "const": "sig" }, "kid": { "type": [ "string", "null" ] }, "x": { "type": [ "string", "null" ] } }, "required": [ "kty", "crv", "alg", "kid", "x" ], "additionalProperties": true } } }, "required": [ "keys" ], "additionalProperties": true }, "CredentialCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "environment": { "type": "string", "enum": [ "live", "test" ] }, "scopes": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 }, "maxItems": 30 }, "expires_at": { "type": "string", "minLength": 1, "maxLength": 100 }, "requests_per_minute": { "type": "integer", "minimum": 1, "maximum": 6000 } }, "required": [ "name", "scopes" ], "additionalProperties": false }, "EnvironmentCreditsRequest": { "type": "object", "properties": { "seconds": { "type": "integer", "minimum": 1, "maximum": 3600 } }, "required": [ "seconds" ], "additionalProperties": false }, "EnvironmentCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "test" ] } }, "required": [ "name" ], "additionalProperties": false }, "WebhookCreateRequest": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "events": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 30 } }, "required": [ "url" ], "additionalProperties": false }, "EmptyRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "WebhookReplayRequest": { "type": "object", "properties": { "event_id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "event_id" ], "additionalProperties": false }, "ToolCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "input_schema": { "type": "object", "properties": {} }, "output_schema": { "type": "object", "properties": {} }, "executor_config": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "http_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "method": { "type": "string", "minLength": 1, "maxLength": 10 }, "http_method": { "type": "string", "minLength": 1, "maxLength": 10 }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "auth": { "type": "object", "properties": {} }, "authentication": { "type": "object", "properties": {} }, "timeout_ms": { "type": "integer", "minimum": 1, "maximum": 30000 }, "argument_mapping": { "type": "object", "properties": {} }, "http_config": { "type": "object", "properties": {} } }, "required": [], "additionalProperties": true }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] } }, "required": [ "name", "executor_config" ], "additionalProperties": false }, "ToolImportRequest": { "type": "object", "properties": { "spec": { "type": "object", "properties": {} }, "operation_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 }, "maxItems": 100 } }, "required": [ "spec" ], "additionalProperties": false }, "ToolUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "input_schema": { "type": "object", "properties": {} }, "output_schema": { "type": "object", "properties": {} }, "executor_config": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "http_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "method": { "type": "string", "minLength": 1, "maxLength": 10 }, "http_method": { "type": "string", "minLength": 1, "maxLength": 10 }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "auth": { "type": "object", "properties": {} }, "authentication": { "type": "object", "properties": {} }, "timeout_ms": { "type": "integer", "minimum": 1, "maximum": 30000 }, "argument_mapping": { "type": "object", "properties": {} }, "http_config": { "type": "object", "properties": {} } }, "required": [], "additionalProperties": true }, "status": { "type": "string", "enum": [ "active", "inactive", "archived" ] } }, "required": [], "additionalProperties": false }, "ToolArgumentsRequest": { "type": "object", "properties": { "arguments": { "type": "object", "properties": {} } }, "required": [], "additionalProperties": false }, "ToolSimulationRequest": { "type": "object", "properties": { "payload": { "type": "object", "properties": {} } }, "required": [ "payload" ], "additionalProperties": false }, "ToolAssignmentRequest": { "type": "object", "properties": { "tool_id": { "type": "string", "minLength": 1, "maxLength": 256 }, "intent_name": { "type": "string", "minLength": 1, "maxLength": 64 }, "enabled": { "type": "boolean" }, "metadata": { "type": "object", "properties": {} } }, "required": [ "tool_id" ], "additionalProperties": false }, "AgentDraftRequest": { "type": "object", "properties": { "agent_spec": { "type": "object" } }, "required": [ "agent_spec" ], "additionalProperties": false }, "AgentRollbackRequest": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 1 } }, "required": [ "version" ], "additionalProperties": false }, "ToolSecretCreateRequest": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1, "maxLength": 16000 } }, "required": [ "value" ], "additionalProperties": false }, "IntegrationToolRequest": { "type": "object", "properties": { "template_id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "template_id" ], "additionalProperties": false }, "KnowledgeCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "default_language": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "name" ], "additionalProperties": false }, "KnowledgeUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "minLength": 1, "maxLength": 4000 }, "default_language": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [], "additionalProperties": false }, "KnowledgeSourceRequest": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 160 }, "filename": { "type": "string", "minLength": 1, "maxLength": 200 }, "text": { "type": "string", "minLength": 1, "maxLength": 1000000 }, "content_base64": { "type": "string", "minLength": 1, "maxLength": 1400000 }, "content_type": { "type": "string", "enum": [ "text/plain", "text/markdown", "text/x-markdown", "application/pdf" ] } }, "required": [], "additionalProperties": false }, "KnowledgeQueryRequest": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1, "maxLength": 4000 }, "limit": { "type": "integer", "minimum": 1, "maximum": 20 } }, "required": [ "query" ], "additionalProperties": false }, "ApplicationOutcomeRequest": { "type": "object", "properties": { "schema": { "type": "object", "properties": {} }, "data": { "type": "object", "properties": {} } }, "required": [ "schema", "data" ], "additionalProperties": false }, "AgentCreateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "minLength": 1, "maxLength": 1000 }, "agent_spec": { "type": "object", "properties": {} }, "draft_spec": { "type": [ "object", "null" ], "properties": {} }, "knowledge_base_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "test_mode_enabled": { "type": "boolean" }, "generated_function_simulations": { "type": "object", "properties": {} }, "status": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "name" ], "additionalProperties": true, "example": { "name": "Support", "description": "Answer questions about our returns policy, using the assigned tools and knowledge." } }, "AgentUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "minLength": 1, "maxLength": 1000 }, "agent_spec": { "type": "object", "properties": {} }, "draft_spec": { "type": [ "object", "null" ], "properties": {} }, "knowledge_base_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 256 }, "test_mode_enabled": { "type": "boolean" }, "generated_function_simulations": { "type": "object", "properties": {} }, "status": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [], "additionalProperties": true }, "AgentPublishRequest": { "type": "object", "properties": {}, "required": [], "additionalProperties": true } }, "responses": { "BadRequestError": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "success": false, "error": "Invalid parameters" } } } }, "UnauthorizedError": { "description": "Unauthorized - missing or invalid API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "success": false, "error": "Invalid API key" } } } }, "ForbiddenError": { "description": "Forbidden - customer suspended", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "success": false, "error": "Customer account is suspended" } } } }, "NotFoundError": { "description": "Not found - resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "success": false, "error": "Agent not found" } } } }, "ValidationError": { "description": "Validation error - request data validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Validation failed" }, "details": { "type": "object", "example": { "name": [ "can't be blank" ], "status": [ "is invalid" ] } } } } } } } } }, "x-realtime-contract": "../integrations/conversimple-messages.schema.json", "x-delivery-contract": "./README.md" }