{ "openapi": "3.1.0", "info": { "title": "OpenBot API", "version": "0.1.0", "description": "Headless REST API for OpenBot. To authenticate, send `Authorization: Bearer `. Create tokens at /v1/user/tokens. Every call needs a permission from a role or policy. Browser clients on the same origin can use the sign-in session Cookie instead. Then every write must send the exact public Origin.\n\nThis reference is made from the same contract that the server and the TypeScript client use, so it always matches the running OpenBot. [Download the OpenAPI document](/openapi.json) to use it with your own tools, such as a code generator. Every OpenBot also serves it at `/openapi.json`. See [Authentication](/authentication) and [Permissions](/permissions)." }, "paths": { "/auth/developer/apps/callback": { "get": { "tags": [ "Public developer tools" ], "operationId": "developerPublic.authorizationCallback", "parameters": [], "security": [], "responses": { "200": { "description": "" }, "400": { "description": "DeveloperInputInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" } ] } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/inspect": { "post": { "tags": [ "Public developer tools" ], "operationId": "developerPublic.inspect", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string" }, "checkedAt": { "type": "number" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "eligibility": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Eligible" ] }, "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "_tag", "entry", "stages" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "withdraw": { "type": "boolean" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "withdraw" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "url": { "type": "string" }, "issue": { "type": "string" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "url", "issue" ], "additionalProperties": false } ] }, "stored": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Known" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "check" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] } }, "required": [ "candidate", "eligibility", "stored" ], "additionalProperties": false } }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "input", "checkedAt", "issues", "apps", "stages" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" } ] } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string", "minLength": 1, "maxLength": 8192 } }, "required": [ "input" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/personal-reports": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.personalReports", "parameters": [ { "name": "before", "in": "query", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "type": "string" }, "checkedAt": { "type": "number" } }, "required": [ "id", "cardUrl", "checkedAt" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/notifications": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.notifications", "parameters": [ { "name": "before", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "IssueAppeared", "IssueResolved", "AccessChanged" ] }, "issue": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reportId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "readAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "cardUrl", "kind", "issue", "reason", "reportId", "createdAt", "readAt" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/notifications/{id}/read": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.readNotification", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "IssueAppeared", "IssueResolved", "AccessChanged" ] }, "issue": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reportId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "readAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "cardUrl", "kind", "issue", "reason", "reportId", "createdAt", "readAt" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/subscriptions": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.subscriptions", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "cardUrl", "enabled" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "put": { "tags": [ "Developer tools" ], "operationId": "developer.subscribe", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "cardUrl", "enabled" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "cardUrl", "enabled" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/indexing": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.requestIndexing", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "generation": { "type": "string" }, "acceptedAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Accepted", "Waiting", "Verifying", "Completed" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] }, "restriction": { "anyOf": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "executionId", "cardUrl", "generation", "acceptedAt", "status", "check", "restriction" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "cardUrl", "commandKey" ], "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "Developer tools" ], "operationId": "developer.indexingRequests", "parameters": [ { "name": "cardUrl", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "generation": { "type": "string" }, "acceptedAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Accepted", "Waiting", "Verifying", "Completed" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] }, "restriction": { "anyOf": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "executionId", "cardUrl", "generation", "acceptedAt", "status", "check", "restriction" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/indexing/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.indexingRequest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "generation": { "type": "string" }, "acceptedAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Accepted", "Waiting", "Verifying", "Completed" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] }, "restriction": { "anyOf": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "executionId", "cardUrl", "generation", "acceptedAt", "status", "check", "restriction" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/tests": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.createTest", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cleanupExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "configurationKeys": { "type": "array", "items": { "type": "string" } }, "issuers": { "type": "array", "items": { "type": "string" } }, "requestedScopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Queued", "Running", "AwaitingConfiguration", "AwaitingAuthorization", "PreparingAuthorization", "ExchangingAuthorization", "Succeeded", "Failed", "Cancelling", "Cancelled", "Interrupted" ] }, "checkedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "configuration", "negotiation", "tools", "resources", "resourceTemplates", "prompts" ] }, "status": { "type": "string", "enum": [ "Passed", "Failed", "NotAdvertised", "NotChecked" ] }, "items": { "type": "array", "items": { "type": "object" } }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "status", "items", "reason" ], "additionalProperties": false } }, "cleanup": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete" ] }, "cleanupRemote": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete", "LocalOnly" ] }, "cleanupLocal": { "type": "string", "enum": [ "Pending", "Complete" ] }, "authorization": { "anyOf": [ { "type": "object", "properties": { "flowId": { "type": "string" }, "status": { "type": "string", "enum": [ "Waiting", "Received", "Exchanging", "Succeeded", "Failed", "Cancelled", "Expired" ] }, "issuer": { "type": "string" }, "resource": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "number" }, "authorizationUrl": { "type": "string" } }, "required": [ "flowId", "status", "issuer", "resource", "scopes", "expiresAt", "authorizationUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "remoteIndex", "endpoint", "configurationKeys", "issuers", "requestedScopes", "createdAt", "expiresAt", "status", "checkedAt", "stages", "cleanup", "cleanupRemote", "cleanupLocal", "authorization", "reason", "candidate" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "cardUrl", "remoteIndex" ], "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "Developer tools" ], "operationId": "developer.tests", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cleanupExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "configurationKeys": { "type": "array", "items": { "type": "string" } }, "issuers": { "type": "array", "items": { "type": "string" } }, "requestedScopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Queued", "Running", "AwaitingConfiguration", "AwaitingAuthorization", "PreparingAuthorization", "ExchangingAuthorization", "Succeeded", "Failed", "Cancelling", "Cancelled", "Interrupted" ] }, "checkedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "configuration", "negotiation", "tools", "resources", "resourceTemplates", "prompts" ] }, "status": { "type": "string", "enum": [ "Passed", "Failed", "NotAdvertised", "NotChecked" ] }, "items": { "type": "array", "items": { "type": "object" } }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "status", "items", "reason" ], "additionalProperties": false } }, "cleanup": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete" ] }, "cleanupRemote": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete", "LocalOnly" ] }, "cleanupLocal": { "type": "string", "enum": [ "Pending", "Complete" ] }, "authorization": { "anyOf": [ { "type": "object", "properties": { "flowId": { "type": "string" }, "status": { "type": "string", "enum": [ "Waiting", "Received", "Exchanging", "Succeeded", "Failed", "Cancelled", "Expired" ] }, "issuer": { "type": "string" }, "resource": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "number" }, "authorizationUrl": { "type": "string" } }, "required": [ "flowId", "status", "issuer", "resource", "scopes", "expiresAt", "authorizationUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "remoteIndex", "endpoint", "configurationKeys", "issuers", "requestedScopes", "createdAt", "expiresAt", "status", "checkedAt", "stages", "cleanup", "cleanupRemote", "cleanupLocal", "authorization", "reason", "candidate" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/tests/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.test", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cleanupExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "configurationKeys": { "type": "array", "items": { "type": "string" } }, "issuers": { "type": "array", "items": { "type": "string" } }, "requestedScopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Queued", "Running", "AwaitingConfiguration", "AwaitingAuthorization", "PreparingAuthorization", "ExchangingAuthorization", "Succeeded", "Failed", "Cancelling", "Cancelled", "Interrupted" ] }, "checkedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "configuration", "negotiation", "tools", "resources", "resourceTemplates", "prompts" ] }, "status": { "type": "string", "enum": [ "Passed", "Failed", "NotAdvertised", "NotChecked" ] }, "items": { "type": "array", "items": { "type": "object" } }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "status", "items", "reason" ], "additionalProperties": false } }, "cleanup": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete" ] }, "cleanupRemote": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete", "LocalOnly" ] }, "cleanupLocal": { "type": "string", "enum": [ "Pending", "Complete" ] }, "authorization": { "anyOf": [ { "type": "object", "properties": { "flowId": { "type": "string" }, "status": { "type": "string", "enum": [ "Waiting", "Received", "Exchanging", "Succeeded", "Failed", "Cancelled", "Expired" ] }, "issuer": { "type": "string" }, "resource": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "number" }, "authorizationUrl": { "type": "string" } }, "required": [ "flowId", "status", "issuer", "resource", "scopes", "expiresAt", "authorizationUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "remoteIndex", "endpoint", "configurationKeys", "issuers", "requestedScopes", "createdAt", "expiresAt", "status", "checkedAt", "stages", "cleanup", "cleanupRemote", "cleanupLocal", "authorization", "reason", "candidate" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "delete": { "tags": [ "Developer tools" ], "operationId": "developer.deleteTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "commandKey", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/tests/{id}/configuration": { "put": { "tags": [ "Developer tools" ], "operationId": "developer.configureTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cleanupExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "configurationKeys": { "type": "array", "items": { "type": "string" } }, "issuers": { "type": "array", "items": { "type": "string" } }, "requestedScopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Queued", "Running", "AwaitingConfiguration", "AwaitingAuthorization", "PreparingAuthorization", "ExchangingAuthorization", "Succeeded", "Failed", "Cancelling", "Cancelled", "Interrupted" ] }, "checkedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "configuration", "negotiation", "tools", "resources", "resourceTemplates", "prompts" ] }, "status": { "type": "string", "enum": [ "Passed", "Failed", "NotAdvertised", "NotChecked" ] }, "items": { "type": "array", "items": { "type": "object" } }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "status", "items", "reason" ], "additionalProperties": false } }, "cleanup": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete" ] }, "cleanupRemote": { "type": "string", "enum": [ "NotRequired", "Pending", "Complete", "LocalOnly" ] }, "cleanupLocal": { "type": "string", "enum": [ "Pending", "Complete" ] }, "authorization": { "anyOf": [ { "type": "object", "properties": { "flowId": { "type": "string" }, "status": { "type": "string", "enum": [ "Waiting", "Received", "Exchanging", "Succeeded", "Failed", "Cancelled", "Expired" ] }, "issuer": { "type": "string" }, "resource": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "number" }, "authorizationUrl": { "type": "string" } }, "required": [ "flowId", "status", "issuer", "resource", "scopes", "expiresAt", "authorizationUrl" ], "additionalProperties": false }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "remoteIndex", "endpoint", "configurationKeys", "issuers", "requestedScopes", "createdAt", "expiresAt", "status", "checkedAt", "stages", "cleanup", "cleanupRemote", "cleanupLocal", "authorization", "reason", "candidate" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": true } } }, "/v1/developer/tests/{id}/run": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.runTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/tests/{id}/cancel": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.cancelTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/tests/{id}/cleanup": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.cleanupTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/tests/{id}/authorization": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.authorizeTest", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "commandKey", "scopes" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/tests/{id}/authorization/complete": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.completeTestAuthorization", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.overview", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "grants": { "type": "array", "items": { "type": "object", "properties": { "proofId": { "type": "string" }, "memberId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "administrator", "maintainer", "viewer" ] } }, "required": [ "proofId", "scope", "role" ], "additionalProperties": false } }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "required": [ "cardUrl", "grants", "candidate" ], "additionalProperties": false } }, "proofs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "transition": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "Confirmed", "Unconfirmed", "Suspended", "Relinquished" ] }, "confirmedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "validUntil": { "type": "number" }, "nextVerificationAt": { "type": "number" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "transition", "scope", "status", "confirmedAt", "validUntil", "nextVerificationAt", "reason" ], "additionalProperties": false } }, "grants": { "type": "array", "items": { "type": "object", "properties": { "proofId": { "type": "string" }, "memberId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "administrator", "maintainer", "viewer" ] } }, "required": [ "proofId", "scope", "role" ], "additionalProperties": false } } }, "required": [ "apps", "proofs", "grants" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/claims": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.startClaim", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "token": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Confirmed", "Revoked", "Expired" ] } }, "required": [ "id", "scope", "token", "createdAt", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] } } }, "required": true } } }, "/v1/developer/claims/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.getClaim", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "token": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Confirmed", "Revoked", "Expired" ] } }, "required": [ "id", "scope", "token", "createdAt", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/claims/{id}/verify": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.verifyClaim", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/claims/{id}/revoke": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.revokeClaim", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "token": { "type": "string" }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Confirmed", "Revoked", "Expired" ] } }, "required": [ "id", "scope", "token", "createdAt", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/proofs/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.getProof", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "transition": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "Confirmed", "Unconfirmed", "Suspended", "Relinquished" ] }, "confirmedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "validUntil": { "type": "number" }, "nextVerificationAt": { "type": "number" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "transition", "scope", "status", "confirmedAt", "validUntil", "nextVerificationAt", "reason" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/proofs/{id}/verify": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.verifyProof", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/proofs/{id}/relinquish": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.relinquish", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "transition": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "status": { "type": "string", "enum": [ "Confirmed", "Unconfirmed", "Suspended", "Relinquished" ] }, "confirmedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "validUntil": { "type": "number" }, "nextVerificationAt": { "type": "number" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "transition", "scope", "status", "confirmedAt", "validUntil", "nextVerificationAt", "reason" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/proofs/{id}/members": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.members", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "identity": { "type": "object", "properties": { "organizationId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "organizationId", "userId" ], "additionalProperties": false }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] } }, "required": [ "id", "proofId", "identity", "role" ], "additionalProperties": false } }, "invitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Accepted", "Revoked" ] } }, "required": [ "id", "proofId", "scope", "role", "expiresAt", "status" ], "additionalProperties": false } } }, "required": [ "members", "invitations" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/proofs/{id}/invitations": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.invite", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Accepted", "Revoked" ] } }, "required": [ "id", "proofId", "scope", "role", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "maintainer", "viewer" ] } }, "required": [ "role" ], "additionalProperties": false } } }, "required": true } } }, "/v1/developer/invitations/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.invitation", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Accepted", "Revoked" ] } }, "required": [ "id", "proofId", "scope", "role", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/invitations/{id}/accept": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.acceptInvitation", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "proofId": { "type": "string" }, "memberId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "administrator", "maintainer", "viewer" ] } }, "required": [ "proofId", "scope", "role" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/invitations/{id}/revoke": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.revokeInvitation", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "scope": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PublisherHostname" ] }, "hostname": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "hostname" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppCard" ] }, "cardUrl": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "cardUrl" ], "additionalProperties": false } ] }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] }, "expiresAt": { "type": "number" }, "status": { "type": "string", "enum": [ "Pending", "Accepted", "Revoked" ] } }, "required": [ "id", "proofId", "scope", "role", "expiresAt", "status" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/members/{id}": { "put": { "tags": [ "Developer tools" ], "operationId": "developer.changeMember", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "proofId": { "type": "string" }, "identity": { "type": "object", "properties": { "organizationId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "organizationId", "userId" ], "additionalProperties": false }, "role": { "type": "string", "enum": [ "maintainer", "viewer" ] } }, "required": [ "id", "proofId", "identity", "role" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "maintainer", "viewer" ] } }, "required": [ "role" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Developer tools" ], "operationId": "developer.removeMember", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "" }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/reports": { "post": { "tags": [ "Developer tools" ], "operationId": "developer.saveInspection", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "type": "string" }, "createdBy": { "type": "string" }, "report": { "type": "object", "properties": { "input": { "type": "string" }, "checkedAt": { "type": "number" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "eligibility": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Eligible" ] }, "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "_tag", "entry", "stages" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "withdraw": { "type": "boolean" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "withdraw" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "url": { "type": "string" }, "issue": { "type": "string" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "url", "issue" ], "additionalProperties": false } ] }, "stored": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Known" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "check" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] } }, "required": [ "candidate", "eligibility", "stored" ], "additionalProperties": false } }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "input", "checkedAt", "issues", "apps", "stages" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "createdBy", "report" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cardUrl": { "type": "string" } }, "required": [ "cardUrl" ], "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "Developer tools" ], "operationId": "developer.reports", "parameters": [ { "name": "cardUrl", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "before", "in": "query", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "type": "string" }, "createdBy": { "type": "string" }, "report": { "type": "object", "properties": { "input": { "type": "string" }, "checkedAt": { "type": "number" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "eligibility": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Eligible" ] }, "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "_tag", "entry", "stages" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "withdraw": { "type": "boolean" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "withdraw" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "url": { "type": "string" }, "issue": { "type": "string" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "url", "issue" ], "additionalProperties": false } ] }, "stored": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Known" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "check" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] } }, "required": [ "candidate", "eligibility", "stored" ], "additionalProperties": false } }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "input", "checkedAt", "issues", "apps", "stages" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "createdBy", "report" ], "additionalProperties": false } } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/reports/{id}": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.report", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "cardUrl": { "type": "string" }, "createdBy": { "type": "string" }, "report": { "type": "object", "properties": { "input": { "type": "string" }, "checkedAt": { "type": "number" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "apps": { "type": "array", "items": { "type": "object", "properties": { "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "eligibility": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Eligible" ] }, "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "_tag", "entry", "stages" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "withdraw": { "type": "boolean" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "withdraw" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } }, "cardUrl": { "type": "string" }, "reason": { "type": "string" }, "url": { "type": "string" }, "issue": { "type": "string" } }, "required": [ "_tag", "stages", "cardUrl", "reason", "url", "issue" ], "additionalProperties": false } ] }, "stored": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Known" ] }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "check" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unknown" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] } }, "required": [ "candidate", "eligibility", "stored" ], "additionalProperties": false } }, "stages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "Input", "Discovery", "CardRead", "CardSchema", "Compatibility", "PublisherAssociation", "Eligibility" ] }, "source": { "type": "string" }, "status": { "type": "string", "enum": [ "Passed", "Failed", "Unconfirmed", "NotChecked" ] }, "checkedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "name", "source", "status" ], "additionalProperties": false } } }, "required": [ "input", "checkedAt", "issues", "apps", "stages" ], "additionalProperties": false } }, "required": [ "id", "cardUrl", "createdBy", "report" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "delete": { "tags": [ "Developer tools" ], "operationId": "developer.deleteReport", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "" }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/developer/reports/{id}/compare": { "get": { "tags": [ "Developer tools" ], "operationId": "developer.compare", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true }, { "name": "other", "in": "query", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "introduced": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "resolved": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } }, "persisting": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "impacts": { "type": "array", "items": { "type": "string", "enum": [ "discovery", "indexing", "connection" ] } }, "stage": { "type": "string", "enum": [ "publication", "catalog", "card", "indexing" ] }, "severity": { "type": "string", "enum": [ "blocking", "suggestion" ] }, "source": { "type": "string" }, "fieldPath": { "type": "string" }, "message": { "type": "string" }, "repair": { "type": "string" } }, "required": [ "code", "stage", "severity", "source", "message", "repair" ], "additionalProperties": false } } }, "required": [ "introduced", "resolved", "persisting" ], "additionalProperties": false } } } }, "400": { "description": "DeveloperInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeveloperInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | DeveloperRestricted | DeveloperForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/DeveloperRestrictedEncoded" }, { "$ref": "#/components/schemas/DeveloperForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DeveloperNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DeveloperNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DeveloperConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DeveloperConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DeveloperUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DeveloperUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-index/sources": { "get": { "tags": [ "App Index" ], "operationId": "appIndex.listSources", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "url": { "type": "string" }, "simulated": { "type": "boolean" } }, "required": [ "id", "name", "url", "simulated" ], "additionalProperties": false } } } } }, "503": { "description": "SettingsUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-index/apps": { "get": { "tags": [ "App Index" ], "operationId": "appIndex.searchApps", "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string", "maxLength": 200 }, "required": false }, { "name": "source", "in": "query", "schema": { "type": "string", "minLength": 1 }, "required": false }, { "name": "cursor", "in": "query", "schema": { "type": "string", "maxLength": 8192 }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "object", "properties": { "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "url": { "type": "string" }, "simulated": { "type": "boolean" } }, "required": [ "id", "name", "url", "simulated" ], "additionalProperties": false } }, "matches": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "publisher" ] } }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false } ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "entry", "sources", "matches" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issues": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1 }, "message": { "type": "string" } }, "required": [ "source", "message" ], "additionalProperties": false } } }, "required": [ "apps", "nextCursor", "issues" ], "additionalProperties": false } } } }, "400": { "description": "IndexInputInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexInputInvalidEncoded" } } } }, "403": { "description": "IndexRestricted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRestrictedEncoded" } } } }, "404": { "description": "IndexNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexNotFoundEncoded" } } } }, "503": { "description": "IndexUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IndexUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-index/app": { "get": { "tags": [ "App Index" ], "operationId": "appIndex.getApp", "parameters": [ { "name": "cardUrl", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "source", "in": "query", "schema": { "type": "string", "minLength": 1 }, "required": false } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "evidence": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "publisherUrl": { "type": "string" }, "catalogUrl": { "type": "string" }, "cardUrl": { "type": "string" }, "association": { "type": "string", "enum": [ "CardOrigin", "Website", "CardLink" ] } }, "required": [ "publisherUrl", "catalogUrl", "cardUrl", "association" ], "additionalProperties": false } }, "checkedAt": { "type": "number" }, "validators": { "type": "object", "properties": { "etag": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastModified": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "cardUrl", "card", "evidence", "checkedAt", "validators" ], "additionalProperties": false }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "url": { "type": "string" }, "simulated": { "type": "boolean" } }, "required": [ "id", "name", "url", "simulated" ], "additionalProperties": false } }, "matches": { "type": "array", "items": { "type": "string", "enum": [ "name", "description", "publisher" ] } }, "check": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Indexed" ] }, "attemptedAt": { "type": "number" } }, "required": [ "_tag", "attemptedAt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Excluded" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Withdrawn" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unconfirmed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "attemptedAt": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "_tag", "attemptedAt", "reason" ], "additionalProperties": false } ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "entry", "sources", "matches" ], "additionalProperties": false } } } }, "400": { "description": "IndexInputInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexInputInvalidEncoded" } } } }, "403": { "description": "IndexRestricted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexRestrictedEncoded" } } } }, "404": { "description": "IndexNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndexNotFoundEncoded" } } } }, "503": { "description": "IndexUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/IndexUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/apps/client-metadata": { "get": { "tags": [ "App authorization callbacks" ], "operationId": "appAuthorizationPublic.appClientMetadata", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "client_id": { "type": "string", "minLength": 1 }, "client_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirect_uris": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "items": { "type": "string" } }, "token_endpoint_auth_method": { "type": "string", "enum": [ "none" ] }, "grant_types": { "type": "array", "items": { "type": "string" } }, "response_types": { "type": "array", "items": { "type": "string" } } }, "required": [ "client_id", "redirect_uris", "token_endpoint_auth_method", "grant_types", "response_types" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } } } }, "503": { "description": "SettingsUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/auth/apps/callback": { "get": { "tags": [ "App authorization callbacks" ], "operationId": "appAuthorizationPublic.appAuthorizationCallback", "parameters": [], "security": [], "responses": { "303": { "description": "" }, "400": { "description": "ExperienceInputInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-authorization-actions/{executionId}": { "get": { "tags": [ "App authorization" ], "operationId": "appAuthorization.getAppAuthorizationAction", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "execution": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false }, "cleanupExecutions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false } }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Removed" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "connectionId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationStarted" ] }, "flowId": { "type": "string", "minLength": 1 }, "authorizationUrl": { "type": "string" }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "flowId", "authorizationUrl", "issuer", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "IssuerSelectionRequired" ] }, "issuers": { "type": "array", "prefixItems": [ { "type": "string" } ], "minItems": 1, "items": { "type": "string" } }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "issuers", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationNotRequired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Refreshed" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "connectionId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Revoked" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "LocalOnly" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RevocationPending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Authorized" ] }, "flowId": { "type": "string" }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "flowId", "connectionId" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "execution", "cleanupExecutions", "result" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/connections/{connectionId}/authorization": { "post": { "tags": [ "App authorization" ], "operationId": "appAuthorization.beginAppAuthorization", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scopes": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "issuer": { "type": "string" }, "returnTo": { "type": "string", "maxLength": 4096 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "revision", "scopes", "commandKey" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "App authorization" ], "operationId": "appAuthorization.revokeAppAuthorization", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-authorizations/{flowId}": { "get": { "tags": [ "App authorization" ], "operationId": "appAuthorization.getAppAuthorization", "parameters": [ { "name": "flowId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "flowId": { "type": "string", "minLength": 1 }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "returnTo": { "type": "string", "maxLength": 4096 }, "expiresAt": { "type": "number" }, "issuer": { "type": "string" }, "resource": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "Waiting", "Received", "Processing", "Succeeded", "Cancelled", "Failed" ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "flowId", "connectionId", "executionId", "returnTo", "expiresAt", "issuer", "resource", "scopes", "status", "reason" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-authorizations/{flowId}/complete": { "post": { "tags": [ "App authorization" ], "operationId": "appAuthorization.completeAppAuthorization", "parameters": [ { "name": "flowId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ExperienceNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AppAuthorizationUnavailable | ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationUnavailableEncoded" }, { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/apps/discover": { "post": { "tags": [ "App discovery" ], "operationId": "apps.discoverApp", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Single" ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidate", "issues" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Multiple" ] }, "candidates": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } ], "minItems": 2, "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidates", "issues" ], "additionalProperties": false } ] } } } }, "400": { "description": "BadRequest | OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "422": { "description": "AppDiscoveryFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Finds Apps at a domain or HTTPS link. Returns OpenBot App Protocol candidates, configuration requirements and provenance (where each candidate came from). It does not add a connection, authorize an account or index a service.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string", "minLength": 1 } }, "required": [ "input" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/messages": { "post": { "tags": [ "Chats" ], "operationId": "chats.sendBotMessage", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "turn": { "type": "string" } }, "required": [ "executionId", "commandKey", "sequence", "chat", "turn" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | FileInvalid | BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChatNotFound | BotNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" }, { "$ref": "#/components/schemas/BotNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChatStorageUnavailable | ChatExecutionUnavailable | BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Sends a message to your Chat with this Bot. OpenBot makes the Chat the first time. When the Bot is free, the message starts a Turn at once. When the Bot works for you, it reads the message at its next step. You need `bots.delegate` on the Bot.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "input": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "user" ] }, "content": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_text" ] }, "text": { "type": "string", "minLength": 1 } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_image" ] }, "file_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "type", "file_id" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_file" ] }, "file_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "type", "file_id" ], "additionalProperties": false } ] }, "minItems": 1 } ] } }, "required": [ "role", "content" ], "additionalProperties": false }, "minItems": 1 } ] }, "queue": { "type": "boolean" } }, "required": [ "commandKey", "input" ], "additionalProperties": false } } }, "required": true } } }, "/v1/chats/{chatId}/messages": { "post": { "tags": [ "Chats" ], "operationId": "chats.sendMessage", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "turn": { "type": "string" } }, "required": [ "executionId", "commandKey", "sequence", "chat", "turn" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChatStorageUnavailable | ChatExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Sends a message to a direct Chat, a task Chat or a live Chat. In a task Chat, the Bot reads it as a message from you. In a live Chat, the message waits until a Live session is open.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "input": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "user" ] }, "content": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_text" ] }, "text": { "type": "string", "minLength": 1 } }, "required": [ "type", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_image" ] }, "file_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "type", "file_id" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "input_file" ] }, "file_id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "type", "file_id" ], "additionalProperties": false } ] }, "minItems": 1 } ] } }, "required": [ "role", "content" ], "additionalProperties": false }, "minItems": 1 } ] }, "queue": { "type": "boolean" } }, "required": [ "commandKey", "input" ], "additionalProperties": false } } }, "required": true } } }, "/v1/chats": { "get": { "tags": [ "Chats" ], "operationId": "chats.listChats", "parameters": [ { "name": "bot", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": false }, { "name": "kind", "in": "query", "schema": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "chat", "delegation" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "createdAt": { "type": "number" } }, "required": [ "id", "revision", "kind", "bot", "parent", "settings", "createdAt" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "Idle", "Running", "Completed", "Failed", "Interrupted" ] }, "turn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] } }, "required": [ "id", "created_at", "status" ], "additionalProperties": false }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "chat", "status", "turn", "response", "executionId" ], "additionalProperties": false } } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists your Chats. Without `kind`, it lists direct Chats, channel Chats and live Chats." } }, "/v1/chats/{chatId}": { "get": { "tags": [ "Chats" ], "operationId": "chats.getChat", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "chat", "delegation" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "createdAt": { "type": "number" } }, "required": [ "id", "revision", "kind", "bot", "parent", "settings", "createdAt" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "Idle", "Running", "Completed", "Failed", "Interrupted" ] }, "turn": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "usage": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "text": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "id": { "type": "string" }, "object": { "type": "string", "enum": [ "response" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "background": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] }, "output": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "assistant" ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "output_text" ] }, "text": { "type": "string" }, "annotations": { "type": "array", "items": false } }, "required": [ "type", "text", "annotations" ], "additionalProperties": false } } }, "required": [ "id", "type", "role", "status", "content" ], "additionalProperties": false } }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "model_error", "internal_error" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] }, "incomplete_details": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter", "other" ] } }, "required": [ "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "chat", "background", "status", "output", "error", "incomplete_details" ], "additionalProperties": false }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "object", "properties": { "delegations": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reminders": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delegations", "requests", "reminders" ], "additionalProperties": false } }, "required": [ "chat", "status", "turn", "response", "executionId", "inbox", "open" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Returns the Chat, its current Turn and its latest response. Reading never starts work." }, "patch": { "tags": [ "Chats" ], "operationId": "chats.updateChat", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "chat", "delegation" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "createdAt": { "type": "number" } }, "required": [ "id", "revision", "kind", "bot", "parent", "settings", "createdAt" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "Idle", "Running", "Completed", "Failed", "Interrupted" ] }, "turn": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "usage": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "text": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "id": { "type": "string" }, "object": { "type": "string", "enum": [ "response" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "background": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] }, "output": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "assistant" ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "output_text" ] }, "text": { "type": "string" }, "annotations": { "type": "array", "items": false } }, "required": [ "type", "text", "annotations" ], "additionalProperties": false } } }, "required": [ "id", "type", "role", "status", "content" ], "additionalProperties": false } }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "model_error", "internal_error" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] }, "incomplete_details": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter", "other" ] } }, "required": [ "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "chat", "background", "status", "output", "error", "incomplete_details" ], "additionalProperties": false }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "object", "properties": { "delegations": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reminders": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delegations", "requests", "reminders" ], "additionalProperties": false } }, "required": [ "chat", "status", "turn", "response", "executionId", "inbox", "open" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | ChatExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the mode, the model or the plan approval of the Chat. A new model also needs `models.use`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "planApproval": { "anyOf": [ { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "expected" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Chats" ], "operationId": "chats.deleteChat", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ChatConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes the history of a direct Chat, a channel Chat or a live Chat. It stops the running Turn and cancels the work that the Chat gave away first. The next message starts an empty Chat.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/chats/{chatId}/models": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatModels", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "selected": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "providers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "models": { "type": "array", "items": { "$ref": "#/components/schemas/Config.ModelEncoded" } } }, "required": [ "providers", "models" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/items": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatItems", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "before", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "$ref": "#/components/schemas/PromptEncoded" }, "origin": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notice": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1 }, "ref": { "type": "string" } }, "required": [ "kind" ], "additionalProperties": false } }, "required": [ "chat", "turn", "step" ], "additionalProperties": false }, "seq": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "content", "seq" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Items of the Chat, newest first. Send `next` as `before` to read older Items." } }, "/v1/chats/{chatId}/turns": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatTurns", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/turns/{turnId}": { "get": { "tags": [ "Chats" ], "operationId": "chats.getTurn", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "turnId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "turn": { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false }, "response": { "type": "object", "properties": { "usage": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "text": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "id": { "type": "string" }, "object": { "type": "string", "enum": [ "response" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "background": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] }, "output": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "assistant" ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "output_text" ] }, "text": { "type": "string" }, "annotations": { "type": "array", "items": false } }, "required": [ "type", "text", "annotations" ], "additionalProperties": false } } }, "required": [ "id", "type", "role", "status", "content" ], "additionalProperties": false } }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "model_error", "internal_error" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] }, "incomplete_details": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter", "other" ] } }, "required": [ "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "chat", "background", "status", "output", "error", "incomplete_details" ], "additionalProperties": false } }, "required": [ "turn", "response" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/turns/{turnId}/items": { "get": { "tags": [ "Chats" ], "operationId": "chats.turnItems", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "turnId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "content": { "$ref": "#/components/schemas/PromptEncoded" }, "origin": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notice": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1 }, "ref": { "type": "string" } }, "required": [ "kind" ], "additionalProperties": false } }, "required": [ "chat", "turn", "step" ], "additionalProperties": false }, "seq": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "content", "seq" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/interrupt": { "post": { "tags": [ "Chats" ], "operationId": "chats.interruptChat", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ChatConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Stops the running Turn. The work that the Chat gave to Bots goes on, unless `delegations` is true.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "delegations": { "type": "boolean" } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/chats/{chatId}/todos": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatTodos", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 100 }, "content": { "type": "string", "minLength": 1, "maxLength": 4000 }, "status": { "type": "string", "enum": [ "pending", "in_progress", "done" ] } }, "required": [ "id", "content", "status" ], "additionalProperties": false }, "maxItems": 1000 } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "put": { "tags": [ "Chats" ], "operationId": "chats.updateChatTodos", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "chat", "delegation" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "createdAt": { "type": "number" } }, "required": [ "id", "revision", "kind", "bot", "parent", "settings", "createdAt" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "Idle", "Running", "Completed", "Failed", "Interrupted" ] }, "turn": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "usage": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "text": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "id": { "type": "string" }, "object": { "type": "string", "enum": [ "response" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "background": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] }, "output": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "assistant" ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "output_text" ] }, "text": { "type": "string" }, "annotations": { "type": "array", "items": false } }, "required": [ "type", "text", "annotations" ], "additionalProperties": false } } }, "required": [ "id", "type", "role", "status", "content" ], "additionalProperties": false } }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "model_error", "internal_error" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] }, "incomplete_details": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter", "other" ] } }, "required": [ "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "chat", "background", "status", "output", "error", "incomplete_details" ], "additionalProperties": false }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "object", "properties": { "delegations": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reminders": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delegations", "requests", "reminders" ], "additionalProperties": false } }, "required": [ "chat", "status", "turn", "response", "executionId", "inbox", "open" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Replaces the todo list of the Chat. The Bot also changes it with its todo tool.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 100 }, "content": { "type": "string", "minLength": 1, "maxLength": 4000 }, "status": { "type": "string", "enum": [ "pending", "in_progress", "done" ] } }, "required": [ "id", "content", "status" ], "additionalProperties": false }, "maxItems": 1000 } }, "required": [ "revision", "items" ], "additionalProperties": false } } }, "required": true } } }, "/v1/chats/{chatId}/delegations": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatDelegations", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "toolCallId": { "type": "string" } }, "required": [ "chat" ], "additionalProperties": false }, "trigger": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "authorizing", "queued", "running", "paused", "completed", "failed", "cancelled" ] }, "task": { "type": "string" }, "reason": { "type": "string" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limits": { "type": "object", "properties": { "timeMs": { "type": "integer", "minimum": 1000, "maximum": 2592000000 }, "steps": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "budgetMicros": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "timeMs" ], "additionalProperties": false }, "usage": { "type": "object", "properties": { "timeMs": { "type": "number" }, "steps": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "costMicros": { "type": "number" } }, "required": [ "timeMs", "steps", "costMicros" ], "additionalProperties": false }, "pause": { "type": "object", "properties": { "limit": { "type": "string", "enum": [ "time", "steps", "budget" ] }, "request": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 }, "at": { "type": "number" } }, "required": [ "limit", "request", "at" ], "additionalProperties": false }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionStatus": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "parent", "bot", "chat", "status", "task", "result", "createdAt", "updatedAt", "executionId", "executionStatus", "failure" ], "additionalProperties": false } } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound | ExecutionNotFound | DelegationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DelegationNotFoundEncoded" } ] } } } }, "409": { "description": "ChatConflict | ExecutionConflict | ExecutionKeyConflict | DelegationConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DelegationConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | ExecutionUnavailable | DelegationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DelegationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the work that this Chat gave to Bots, with its status and result." } }, "/v1/chats/{chatId}/confessions": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatConfessions", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "turn": { "type": "string" }, "text": { "type": "string" }, "reply": { "type": "string" }, "at": { "type": "number" } }, "required": [ "id", "chat", "turn", "text", "reply", "at" ], "additionalProperties": false } } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists what the Bot said with `confide` in this Chat, and the answers that it got. The Bot uses it to talk about how its work goes. See the client guide before you show it to people." } }, "/v1/chats/{chatId}/enrichments": { "get": { "tags": [ "Chats" ], "operationId": "chats.chatEnrichments", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "text": { "type": "string" }, "original": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "entries": { "type": "array", "items": { "type": "string" } }, "at": { "type": "number" } }, "required": [ "chat", "turn", "text", "entries", "at" ], "additionalProperties": false } } } } }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists what the memory Bot added to the input of each Turn, and the Bot memory entries that it used." } }, "/v1/chats/{chatId}/tool-calls": { "get": { "tags": [ "Tool calls" ], "operationId": "toolCalls.list", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "position": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "item": { "type": "string" }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "chat", "turn", "item", "step" ], "additionalProperties": false }, "callId": { "type": "string" }, "tool": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "detached": { "type": "boolean" }, "startedAt": { "type": "number" }, "deadline": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "executionId", "parentExecutionId", "position", "callId", "tool", "status", "detached", "startedAt", "deadline", "failure" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Imported" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "tool": { "type": "string" }, "kind": { "type": "string", "enum": [ "tool", "session" ] }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "startedAt": { "type": "number" }, "endedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "id", "executionId", "parentExecutionId", "chat", "turn", "callId", "tool", "kind", "status", "startedAt", "endedAt", "failure" ], "additionalProperties": false } ] } } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ToolCallNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ToolCallNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/tool-calls/{id}": { "get": { "tags": [ "Tool calls" ], "operationId": "toolCalls.get", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "position": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "item": { "type": "string" }, "step": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "chat", "turn", "item", "step" ], "additionalProperties": false }, "callId": { "type": "string" }, "tool": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "detached": { "type": "boolean" }, "startedAt": { "type": "number" }, "deadline": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "output": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "id", "executionId", "parentExecutionId", "position", "callId", "tool", "status", "detached", "startedAt", "deadline", "failure", "output" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Imported" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "parentExecutionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "tool": { "type": "string" }, "kind": { "type": "string", "enum": [ "tool", "session" ] }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "startedAt": { "type": "number" }, "endedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "output": { "anyOf": [ {}, { "type": "null" } ] } }, "required": [ "_tag", "id", "executionId", "parentExecutionId", "chat", "turn", "callId", "tool", "kind", "status", "startedAt", "endedAt", "failure", "output" ], "additionalProperties": false } ] } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ToolCallNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ToolCallNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/executions/{executionId}": { "get": { "tags": [ "Executions" ], "operationId": "executions.get", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/executions/{executionId}/events": { "get": { "tags": [ "Executions" ], "operationId": "executions.events", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "afterSequence", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "body": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Wake" ] }, "key": { "type": "string" } }, "required": [ "_tag", "key" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "State" ] }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "status", "failure" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "StepStarted" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Text" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "text": { "type": "string" } }, "required": [ "_tag", "step", "attempt", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ToolOutput" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": {} }, "required": [ "_tag", "step", "attempt", "output" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "StepCompleted" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CallRecorded" ] }, "callId": { "type": "string", "minLength": 1, "maxLength": 128 }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "callId", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DecisionNeeded" ] }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "choices": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } ], "minItems": 1, "items": { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } } }, "required": [ "_tag", "decisionId", "choices" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DecisionMade" ] }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "answer": { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } }, "required": [ "_tag", "decisionId", "answer" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Result" ] }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false } }, "required": [ "_tag", "resource" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputMoved" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "executionId", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChildExecution" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "step": { "type": "string" } }, "required": [ "_tag", "executionId", "step" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Checkpoint" ] }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "resource", "revision" ], "additionalProperties": false } ] } }, "required": [ "executionId", "sequence", "createdAt", "body" ], "additionalProperties": false } }, "afterSequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "terminal": { "type": "boolean" } }, "required": [ "events", "afterSequence", "terminal" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/executions/{executionId}/observe": { "get": { "tags": [ "Executions" ], "operationId": "executions.observe", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "afterSequence", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "text/event-stream": { "schema": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "execution" ] }, "id": { "type": "string" }, "data": { "type": "string", "contentMediaType": "application/json", "contentSchema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "body": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Wake" ] }, "key": { "type": "string" } }, "required": [ "_tag", "key" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "State" ] }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "_tag", "status", "failure" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "StepStarted" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Text" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "text": { "type": "string" } }, "required": [ "_tag", "step", "attempt", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ToolOutput" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": {} }, "required": [ "_tag", "step", "attempt", "output" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "StepCompleted" ] }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CallRecorded" ] }, "callId": { "type": "string", "minLength": 1, "maxLength": 128 }, "step": { "type": "string" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "callId", "step", "attempt" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DecisionNeeded" ] }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "choices": { "type": "array", "prefixItems": [ { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } ], "minItems": 1, "items": { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } } }, "required": [ "_tag", "decisionId", "choices" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DecisionMade" ] }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "answer": { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } }, "required": [ "_tag", "decisionId", "answer" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Result" ] }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false } }, "required": [ "_tag", "resource" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputMoved" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "items": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "executionId", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChildExecution" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "step": { "type": "string" } }, "required": [ "_tag", "executionId", "step" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Checkpoint" ] }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "resource", "revision" ], "additionalProperties": false } ] } }, "required": [ "executionId", "sequence", "createdAt", "body" ], "additionalProperties": false } } }, "required": [ "event", "id", "data" ], "additionalProperties": false }, "x-effect-stream": { "encoding": "sse", "causeSchema": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Fail" ] }, "error": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionNotFound" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionConflict" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionKeyConflict" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionForbidden" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionUnavailable" ] }, "errorId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "errorId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestFailed" ] }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] }, "errorId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "category", "errorId" ], "additionalProperties": false } ] } }, "required": [ "_tag", "error" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Die" ] }, "defect": {} }, "required": [ "_tag", "defect" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupt" ] }, "fiberId": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "_tag", "fiberId" ], "additionalProperties": false } ] } }, "errorSchema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] }, "failureEvent": "effect/http-api/stream/failure" } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/executions/{executionId}/cancel": { "post": { "tags": [ "Executions" ], "operationId": "executions.cancel", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/executions/{executionId}/decisions": { "post": { "tags": [ "Executions" ], "operationId": "executions.decide", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "decisionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "answer": { "type": "string", "enum": [ "allow", "deny", "retry", "stop" ] } }, "required": [ "commandKey", "decisionId", "answer" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/live": { "post": { "tags": [ "Live" ], "operationId": "live.createLiveChat", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "chat": { "type": "object", "properties": { "id": { "type": "string" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "direct", "channel", "task", "review", "live" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "chat", "delegation" ], "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "createdAt": { "type": "number" } }, "required": [ "id", "revision", "kind", "bot", "parent", "settings", "createdAt" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "Idle", "Running", "Completed", "Failed", "Interrupted" ] }, "turn": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "chat": { "type": "string" }, "settings": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "build", "plan" ] }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "required": [ "mode" ], "additionalProperties": false }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false }, "author": { "type": "string", "minLength": 1 }, "activeAction": { "type": "object", "properties": { "item": { "type": "string" }, "action": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" }, "source": { "type": "object" } }, "required": [ "name", "arguments" ], "additionalProperties": false } }, "required": [ "item", "action" ], "additionalProperties": false }, "status": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Running" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": { "type": "object", "properties": { "text": { "type": "string" }, "finishReason": { "type": "string", "enum": [ "stop", "length", "content-filter", "tool-calls", "error", "pause", "other", "unknown" ] } }, "required": [ "text", "finishReason" ], "additionalProperties": false } }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "message": { "type": "string" }, "code": { "type": "string", "enum": [ "model_error", "internal_error" ] } }, "required": [ "_tag", "message", "code" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Interrupted" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "steps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/effect_ai_AiResponse_UsageEncoded" } }, "input": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "string" } }, "startedAt": { "type": "number" }, "completedAt": { "type": "number" } }, "required": [ "id", "chat", "settings", "status", "steps", "input", "items", "startedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "response": { "anyOf": [ { "type": "object", "properties": { "usage": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "uncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "cacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "text": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "id": { "type": "string" }, "object": { "type": "string", "enum": [ "response" ] }, "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "background": { "type": "boolean", "enum": [ true ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "failed", "cancelled" ] }, "output": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "message" ] }, "role": { "type": "string", "enum": [ "assistant" ] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, "content": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "output_text" ] }, "text": { "type": "string" }, "annotations": { "type": "array", "items": false } }, "required": [ "type", "text", "annotations" ], "additionalProperties": false } } }, "required": [ "id", "type", "role", "status", "content" ], "additionalProperties": false } }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string", "enum": [ "model_error", "internal_error" ] }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] }, "incomplete_details": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "max_output_tokens", "content_filter", "other" ] } }, "required": [ "reason" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "object", "created_at", "chat", "background", "status", "output", "error", "incomplete_details" ], "additionalProperties": false }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "open": { "type": "object", "properties": { "delegations": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reminders": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delegations", "requests", "reminders" ], "additionalProperties": false } }, "required": [ "chat", "status", "turn", "response", "executionId", "inbox", "open" ], "additionalProperties": false } } } }, "400": { "description": "ChatModelInvalid | BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound | BotNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatNotFoundEncoded" }, { "$ref": "#/components/schemas/BotNotFoundEncoded" } ] } } } }, "409": { "description": "ChatConflict | @nmnmcc/ability/Authorizer/Pending | BotConflict | LiveUnavailable", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" }, { "$ref": "#/components/schemas/LiveUnavailableEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Makes a new live Chat of yours with this Bot. Then open its Live WebSocket. You need `bots.delegate` on the Bot and `models.use` on the Live model.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/chats/{chatId}/live": { "get": { "tags": [ "Live" ], "operationId": "live.connectLive", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "name": "voice", "in": "query", "schema": { "type": "string", "minLength": 1 }, "required": false }, { "name": "inputFormat", "in": "query", "schema": { "type": "string", "pattern": "^(?:pcm16|g711_ulaw|g711_alaw|opus)@[+-]?(?:\\d+(?:\\.\\d+)?|\\.\\d+)(?:[Ee][+-]?\\d+)?$" }, "required": false }, { "name": "outputFormat", "in": "query", "schema": { "type": "string", "pattern": "^(?:pcm16|g711_ulaw|g711_alaw|opus)@[+-]?(?:\\d+(?:\\.\\d+)?|\\.\\d+)(?:[Ee][+-]?\\d+)?$" }, "required": false }, { "name": "turnDetection", "in": "query", "schema": { "type": "string", "enum": [ "server", "client" ] }, "required": false }, { "name": "organization", "in": "query", "schema": { "type": "string", "minLength": 1 }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChatNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatNotFoundEncoded" } } } }, "409": { "description": "ChatConflict | LiveUnavailable | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/LiveUnavailableEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChatStorageUnavailable | ChatExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Opens the Live WebSocket of a live Chat. Each thing the person says starts a Turn, and the Bot answers with sound and text. Turns use the shared execution engine. Sound stays on the open connection. A browser must connect from the public origin." } }, "/v1/files": { "post": { "tags": [ "Files" ], "operationId": "files.uploadFile", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "object": { "type": "string", "enum": [ "file" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "ready" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "object", "filename", "mediaType", "bytes", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Uploads one file through OpenBot, as `multipart/form-data` with the field `file`. The file is ready at once. The platform can turn this way off.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ], "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "Files" ], "operationId": "files.listFiles", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "after", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "object": { "type": "string", "enum": [ "file" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "ready" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "object", "filename", "mediaType", "bytes", "status", "createdAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the files that you may read, newest first." } }, "/v1/files/uploads": { "post": { "tags": [ "Files" ], "operationId": "files.createUpload", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "object": { "type": "string", "enum": [ "file" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "ready" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "object", "filename", "mediaType", "bytes", "status", "createdAt" ], "additionalProperties": false }, "url": { "type": "string" }, "method": { "type": "string", "enum": [ "PUT" ] }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "type": "number" } }, "required": [ "file", "url", "method", "headers", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Makes a pending file and a signed address in object storage. The client puts the bytes there itself, then completes the file. The platform can turn this way off.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "filename": { "type": "string", "minLength": 1, "maxLength": 255 }, "mediaType": { "type": "string", "minLength": 2, "maxLength": 255 }, "bytes": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "filename", "mediaType", "bytes" ], "additionalProperties": false } } }, "required": true } } }, "/v1/files/{fileId}/complete": { "post": { "tags": [ "Files" ], "operationId": "files.completeUpload", "parameters": [ { "name": "fileId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "object": { "type": "string", "enum": [ "file" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "ready" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "object", "filename", "mediaType", "bytes", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Checks that the bytes are in object storage with the right size, and makes the file ready." } }, "/v1/files/{fileId}": { "get": { "tags": [ "Files" ], "operationId": "files.getFile", "parameters": [ { "name": "fileId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "object": { "type": "string", "enum": [ "file" ] }, "filename": { "type": "string" }, "mediaType": { "type": "string" }, "bytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "ready" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "object", "filename", "mediaType", "bytes", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "delete": { "tags": [ "Files" ], "operationId": "files.deleteFile", "parameters": [ { "name": "fileId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "FilesDisabled | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes a file now. Chats that used it keep their text, but the model no longer sees the file." } }, "/v1/files/{fileId}/content": { "get": { "tags": [ "Files" ], "operationId": "files.getFileContent", "parameters": [ { "name": "fileId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" }, "x-effect-stream": { "encoding": "uint8array" } } } }, "400": { "description": "FileInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FileInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "FileNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileNotFoundEncoded" } } } }, "409": { "description": "FilesDisabled | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesDisabledEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "413": { "description": "FileQuotaExceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileQuotaExceededEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "FilesUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/FilesUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives the bytes of a ready file." } }, "/v1/delegations/{delegationId}": { "get": { "tags": [ "Delegations" ], "operationId": "delegations.getDelegation", "parameters": [ { "name": "delegationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "parent": { "type": "object", "properties": { "chat": { "type": "string" }, "turn": { "type": "string" }, "toolCallId": { "type": "string" } }, "required": [ "chat" ], "additionalProperties": false }, "trigger": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "authorizing", "queued", "running", "paused", "completed", "failed", "cancelled" ] }, "task": { "type": "string" }, "reason": { "type": "string" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limits": { "type": "object", "properties": { "timeMs": { "type": "integer", "minimum": 1000, "maximum": 2592000000 }, "steps": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "budgetMicros": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "timeMs" ], "additionalProperties": false }, "usage": { "type": "object", "properties": { "timeMs": { "type": "number" }, "steps": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "costMicros": { "type": "number" } }, "required": [ "timeMs", "steps", "costMicros" ], "additionalProperties": false }, "pause": { "type": "object", "properties": { "limit": { "type": "string", "enum": [ "time", "steps", "budget" ] }, "request": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 }, "at": { "type": "number" } }, "required": [ "limit", "request", "at" ], "additionalProperties": false }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionStatus": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "parent", "bot", "chat", "status", "task", "result", "createdAt", "updatedAt", "executionId", "executionStatus", "failure" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DelegationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DelegationNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DelegationConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DelegationConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DelegationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DelegationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Reads one piece of work that a Bot gave away, from one of your Chats." } }, "/v1/delegations/{delegationId}/cancel": { "post": { "tags": [ "Delegations" ], "operationId": "delegations.cancelDelegation", "parameters": [ { "name": "delegationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | DelegationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/DelegationNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | DelegationConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/DelegationConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | DelegationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/DelegationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Asks the execution to stop this work and its child work. Observe the execution until its resources are released.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots": { "get": { "tags": [ "Bots" ], "operationId": "bots.listBots", "parameters": [ { "name": "archived", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] }, "required": false }, { "name": "bot", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "bot", "userId" ], "additionalProperties": false } ] }, "name": { "type": "string" }, "role": { "type": "string" }, "instructions": { "type": "string" }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "source": { "type": "object", "properties": { "organizationId": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "organizationId", "bot" ], "additionalProperties": false }, "archived": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "name", "role", "instructions", "archived", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Bots that the caller can use: their own Bots and the shared Bots. With `bot`, it lists the Bots that this Bot owns." }, "post": { "tags": [ "Bots" ], "operationId": "bots.createBot", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "bot", "userId" ], "additionalProperties": false } ] }, "name": { "type": "string" }, "role": { "type": "string" }, "instructions": { "type": "string" }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "source": { "type": "object", "properties": { "organizationId": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "organizationId", "bot" ], "additionalProperties": false }, "archived": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "name", "role", "instructions", "archived", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string", "maxLength": 500 }, "instructions": { "type": "string", "maxLength": 20000 }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "shared": { "type": "boolean" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "name", "role", "instructions" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}": { "get": { "tags": [ "Bots" ], "operationId": "bots.getBot", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "bot", "userId" ], "additionalProperties": false } ] }, "name": { "type": "string" }, "role": { "type": "string" }, "instructions": { "type": "string" }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "source": { "type": "object", "properties": { "organizationId": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "organizationId", "bot" ], "additionalProperties": false }, "archived": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "name", "role", "instructions", "archived", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Bots" ], "operationId": "bots.updateBot", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "bot", "userId" ], "additionalProperties": false } ] }, "name": { "type": "string" }, "role": { "type": "string" }, "instructions": { "type": "string" }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "source": { "type": "object", "properties": { "organizationId": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "organizationId", "bot" ], "additionalProperties": false }, "archived": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "name", "role", "instructions", "archived", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" }, "role": { "type": "string", "maxLength": 500 }, "instructions": { "type": "string", "maxLength": 20000 }, "model": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "planApproval": { "anyOf": [ { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, { "type": "null" } ] }, "archived": { "type": "boolean" } }, "required": [ "expected" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/memory": { "get": { "tags": [ "Bots" ], "operationId": "bots.botMemory", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "tags", "in": "query", "schema": { "type": "string", "minLength": 1 }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "layer": { "type": "string", "enum": [ "fact", "observation", "pinned" ] }, "content": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "item": { "type": "string" } }, "required": [ "chat", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "entry": { "type": "string" } }, "required": [ "entry" ], "additionalProperties": false } ] } }, "confidence": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "retracted" ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "invalidatedAt": { "type": "number" } }, "required": [ "id", "layer", "content", "tags", "sources", "status", "createdAt", "updatedAt" ], "additionalProperties": false } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "entries", "version" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Reads the entries of the Bot memory that the caller may see: entries for the caller, for a Channel group that the caller is in, or for everyone who uses the Bot, in the organization of the caller. Nobody can read the memory about another person." }, "post": { "tags": [ "Bots" ], "operationId": "bots.updateBotMemory", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "layer": { "type": "string", "enum": [ "fact", "observation", "pinned" ] }, "content": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "chat": { "type": "string" }, "item": { "type": "string" } }, "required": [ "chat", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "entry": { "type": "string" } }, "required": [ "entry" ], "additionalProperties": false } ] } }, "confidence": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "retracted" ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "invalidatedAt": { "type": "number" } }, "required": [ "id", "layer", "content", "tags", "sources", "status", "createdAt", "updatedAt" ], "additionalProperties": false } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "entries", "version" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Remembers something about the caller, or takes back what the caller gave to an entry.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "command": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Remember" ] }, "content": { "type": "string", "minLength": 1 }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Forget" ] }, "id": { "type": "string", "minLength": 1 } }, "required": [ "_tag", "id" ], "additionalProperties": false } ] } }, "required": [ "command" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/memory/log": { "get": { "tags": [ "Bots" ], "operationId": "bots.botMemoryLog", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "at": { "type": "number" }, "by": { "type": "string", "enum": [ "memory_bot", "person", "promotion" ] }, "ids": { "type": "array", "items": { "type": "string" } }, "reason": { "type": "string" } }, "required": [ "version", "at", "by", "ids" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the changes that touch entries that the caller may see." } }, "/v1/bots/{botId}/memory/purge": { "post": { "tags": [ "Bots" ], "operationId": "bots.purgeBotMemory", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "removed" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Removes every entry with one tag of OpenBot, like `from:` or `chat:`, without showing them. It needs `bots.write` on a Bot that is not linked.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string" } }, "required": [ "tag" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/memory/bot": { "get": { "tags": [ "Bots" ], "operationId": "bots.memoryBot", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "instructions": { "type": "string" }, "concurrency": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "budget": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "period", "limitMicros" ], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "instructions", "revision" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Reads the settings of the memory Bot that keeps the memory of this Bot. It needs `bots.write` on a Bot that is not linked." }, "patch": { "tags": [ "Bots" ], "operationId": "bots.updateMemoryBot", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "instructions": { "type": "string" }, "concurrency": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "budget": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "period", "limitMicros" ], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "instructions", "revision" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the rules, the concurrency and the budget of the memory Bot. It needs `bots.write` on a Bot that is not linked.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "instructions": { "type": "string", "maxLength": 20000 }, "concurrency": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "budget": { "anyOf": [ { "type": "object", "properties": { "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "period", "limitMicros" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "expected" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/rules": { "get": { "tags": [ "Bots" ], "operationId": "bots.listRules", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "author": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "text": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "proposed", "retired" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "bot", "author", "text", "status", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Bots" ], "operationId": "bots.createRule", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "author": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "text": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "proposed", "retired" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "bot", "author", "text", "status", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a Rule that the caller wrote for this Bot. A Rule from a person is active at once.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "text" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/rules/{ruleId}": { "patch": { "tags": [ "Bots" ], "operationId": "bots.updateRule", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "ruleId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "author": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "text": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "proposed", "retired" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "bot", "author", "text", "status", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | RuleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/RuleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the text of a Rule, confirms a proposed Rule, or retires a Rule.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "text": { "type": "string", "minLength": 1, "maxLength": 4000 }, "status": { "type": "string", "enum": [ "active", "retired" ] } }, "required": [ "expected" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/grants": { "get": { "tags": [ "Bots" ], "operationId": "bots.listGrants", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "active", "used", "revoked" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "capability": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "tools.call", "apps.call", "bots.create", "bots.delegate", "plans.run", "channels.send", "delegations.continue", "computers.acquire", "computers.create", "computers.delete", "computers.expose" ] }, "target": { "type": "string", "maxLength": 512 }, "arguments": { "type": "object" } }, "required": [ "action", "target" ], "additionalProperties": false }, "effect": { "type": "string", "enum": [ "allow", "deny" ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "chat": { "type": "string" }, "grantedBy": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "reason": { "type": "string" }, "parent": { "type": "string", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "active", "used", "revoked" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "bot", "capability", "effect", "scope", "grantedBy", "status", "createdAt" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Bots" ], "operationId": "bots.createGrant", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "capability": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "tools.call", "apps.call", "bots.create", "bots.delegate", "plans.run", "channels.send", "delegations.continue", "computers.acquire", "computers.create", "computers.delete", "computers.expose" ] }, "target": { "type": "string", "maxLength": 512 }, "arguments": { "type": "object" } }, "required": [ "action", "target" ], "additionalProperties": false }, "effect": { "type": "string", "enum": [ "allow", "deny" ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "chat": { "type": "string" }, "grantedBy": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "reason": { "type": "string" }, "parent": { "type": "string", "minLength": 1, "maxLength": 128 }, "status": { "type": "string", "enum": [ "active", "used", "revoked" ] }, "createdAt": { "type": "number" } }, "required": [ "id", "bot", "capability", "effect", "scope", "grantedBy", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "capability": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "tools.call", "apps.call", "bots.create", "bots.delegate", "plans.run", "channels.send", "delegations.continue", "computers.acquire", "computers.create", "computers.delete", "computers.expose" ] }, "target": { "type": "string", "maxLength": 512 }, "arguments": { "type": "object" } }, "required": [ "action", "target" ], "additionalProperties": false }, "effect": { "type": "string", "enum": [ "allow", "deny" ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string", "maxLength": 2000 } }, "required": [ "capability", "effect", "scope" ], "additionalProperties": false } } }, "required": true } } }, "/v1/bots/{botId}/grants/{grantId}": { "delete": { "tags": [ "Bots" ], "operationId": "bots.revokeGrant", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "grantId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | GrantNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/GrantNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Revokes a Grant and every Grant that came from it." } }, "/v1/bots/{botId}/members": { "get": { "tags": [ "Bots" ], "operationId": "bots.listBotMembers", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "organizationId": { "type": "string" }, "linked": { "type": "string", "minLength": 1, "maxLength": 128 }, "joinedAt": { "type": "number" } }, "required": [ "userId", "organizationId", "linked", "joinedAt" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the people who use this Bot in their own organizations. It needs `bots.share`." } }, "/v1/bots/{botId}/members/{userId}": { "delete": { "tags": [ "Bots" ], "operationId": "bots.removeBotMember", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes a person off this Bot. Their linked Bot stops working at once." } }, "/v1/bots/{botId}/invitations": { "post": { "tags": [ "Bots" ], "operationId": "bots.createBotInvitation", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "path": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "bot", "email", "prefix", "path", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "invitation", "secret", "url" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | InvitationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/InvitationNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Invites a person by email, or makes an invitation link, to use this Bot. It needs `bots.share`. Only a lasting top Bot can be shared.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320 }, "expiresAt": { "type": "number" }, "path": { "type": "string", "maxLength": 4096 } }, "additionalProperties": false } } }, "required": true } }, "get": { "tags": [ "Bots" ], "operationId": "bots.listBotInvitations", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "path": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "bot", "email", "prefix", "path", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | InvitationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/InvitationNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/bots/{botId}/invitations/{invitationId}/secret": { "get": { "tags": [ "Bots" ], "operationId": "bots.botInvitationSecret", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "invitationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "path": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "bot", "email", "prefix", "path", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false }, "secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "invitation", "secret", "url" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | InvitationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/InvitationNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Reads the secret and the URL of an invitation link again, for example to print its QR code again." } }, "/v1/bots/{botId}/invitations/{invitationId}": { "delete": { "tags": [ "Bots" ], "operationId": "bots.revokeBotInvitation", "parameters": [ { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "invitationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "BotInvalid | InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | InvitationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/InvitationNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes back a pending invitation. People who accepted it stay members." } }, "/v1/bot-invitations/accept": { "post": { "tags": [ "Bot invitations" ], "operationId": "botInvitations.acceptBotInvitation", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "bot", "userId" ], "additionalProperties": false } ] }, "name": { "type": "string" }, "role": { "type": "string" }, "instructions": { "type": "string" }, "model": { "$ref": "#/components/schemas/Config.SelectionEncoded" }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "source": { "type": "object", "properties": { "organizationId": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "organizationId", "bot" ], "additionalProperties": false }, "archived": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "name", "role", "instructions", "archived", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | InvitationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/InvitationInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | InvitationNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/InvitationNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" } ] } } } }, "503": { "description": "BotStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Accepts an email invitation (`invitation`) or an invitation link (`secret`). It makes a linked Bot in your organization and gives it back. When you already use the Bot, it gives back your linked Bot.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "invitation": { "type": "string", "minLength": 1, "maxLength": 128 }, "secret": { "type": "string", "minLength": 1, "maxLength": 512 }, "organization": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/requests": { "get": { "tags": [ "Requests" ], "operationId": "requests.listRequests", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "allowed", "denied", "expired", "cancelled" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "capability": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "tools.call", "apps.call", "bots.create", "bots.delegate", "plans.run", "channels.send", "delegations.continue", "computers.acquire", "computers.create", "computers.delete", "computers.expose" ] }, "target": { "type": "string", "maxLength": 512 }, "arguments": { "type": "object" } }, "required": [ "action", "target" ], "additionalProperties": false }, "reason": { "type": "string" }, "approver": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false } ] }, "chain": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 } }, "chat": { "type": "string" }, "turn": { "type": "string" }, "toolCallId": { "type": "string" }, "app": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "PendingApproval", "Approved", "Rejected", "Sending", "InputRequired", "Completed", "Failed", "OutcomeUnknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "result": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "request": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "reason": { "type": "string" }, "cause": { "type": "string" }, "message": { "type": "string" }, "result": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "reason", "message" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result" ], "additionalProperties": false }, "code": { "type": "object", "properties": { "run": { "type": "string", "minLength": 1, "maxLength": 128 }, "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "code": { "type": "string" } }, "required": [ "run", "index", "code" ], "additionalProperties": false }, "endorsements": { "type": "array", "items": { "type": "object", "properties": { "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string" } }, "required": [ "bot", "scope" ], "additionalProperties": false } }, "status": { "type": "string", "enum": [ "pending", "allowed", "denied", "expired", "cancelled" ] }, "decision": { "anyOf": [ { "type": "object", "properties": { "by": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string" }, "question": { "type": "string" }, "at": { "type": "number" } }, "required": [ "by", "at" ], "additionalProperties": false }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "onExpire": { "type": "string", "enum": [ "allow", "deny" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionStatus": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] } }, "required": [ "id", "bot", "capability", "reason", "approver", "chain", "chat", "turn", "toolCallId", "endorsements", "status", "decision", "revision", "createdAt", "expiresAt", "executionId", "executionStatus" ], "additionalProperties": false } } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | ExecutionNotFound | RequestNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/RequestNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict | ExecutionConflict | ExecutionKeyConflict | RequestConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/RequestConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the requests that wait for the caller, or that the caller answered." } }, "/v1/requests/{requestId}": { "get": { "tags": [ "Requests" ], "operationId": "requests.getRequest", "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "capability": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "tools.call", "apps.call", "bots.create", "bots.delegate", "plans.run", "channels.send", "delegations.continue", "computers.acquire", "computers.create", "computers.delete", "computers.expose" ] }, "target": { "type": "string", "maxLength": 512 }, "arguments": { "type": "object" } }, "required": [ "action", "target" ], "additionalProperties": false }, "reason": { "type": "string" }, "approver": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false } ] }, "chain": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 } }, "chat": { "type": "string" }, "turn": { "type": "string" }, "toolCallId": { "type": "string" }, "app": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "PendingApproval", "Approved", "Rejected", "Sending", "InputRequired", "Completed", "Failed", "OutcomeUnknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "result": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "request": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "reason": { "type": "string" }, "cause": { "type": "string" }, "message": { "type": "string" }, "result": {}, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "source", "reason", "message" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result" ], "additionalProperties": false }, "code": { "type": "object", "properties": { "run": { "type": "string", "minLength": 1, "maxLength": 128 }, "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "code": { "type": "string" } }, "required": [ "run", "index", "code" ], "additionalProperties": false }, "endorsements": { "type": "array", "items": { "type": "object", "properties": { "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string" } }, "required": [ "bot", "scope" ], "additionalProperties": false } }, "status": { "type": "string", "enum": [ "pending", "allowed", "denied", "expired", "cancelled" ] }, "decision": { "anyOf": [ { "type": "object", "properties": { "by": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Person" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bot" ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Rule" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false } ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string" }, "question": { "type": "string" }, "at": { "type": "number" } }, "required": [ "by", "at" ], "additionalProperties": false }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "expiresAt": { "type": "number" }, "onExpire": { "type": "string", "enum": [ "allow", "deny" ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionStatus": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] } }, "required": [ "id", "bot", "capability", "reason", "approver", "chain", "chat", "turn", "toolCallId", "endorsements", "status", "decision", "revision", "createdAt", "expiresAt", "executionId", "executionStatus" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | ExecutionNotFound | RequestNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/RequestNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict | ExecutionConflict | ExecutionKeyConflict | RequestConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/RequestConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Requests" ], "operationId": "requests.resolveRequest", "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "BotInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BotNotFound | ExecutionNotFound | RequestNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BotNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/RequestNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BotConflict | ExecutionConflict | ExecutionKeyConflict | RequestConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BotConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/RequestConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BotStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BotStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Saves one decision and returns its execution receipt. The workflow sends the result to the Chat.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "decision": { "type": "string", "enum": [ "allow", "deny" ] }, "scope": { "type": "string", "enum": [ "once", "chat", "lifetime" ] }, "reason": { "type": "string", "maxLength": 2000 }, "rule": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "commandKey", "expected", "decision" ], "additionalProperties": false } } }, "required": true } } }, "/v1/me/settings": { "get": { "tags": [ "Your settings" ], "operationId": "memberSettings.getMemberSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "planApproval": { "anyOf": [ { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, { "type": "null" } ] }, "defaultBot": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "updatedAt": { "type": "string" } }, "required": [ "version", "planApproval", "defaultBot", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Your settings" ], "operationId": "memberSettings.updateMemberSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "planApproval": { "anyOf": [ { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, { "type": "null" } ] }, "defaultBot": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "updatedAt": { "type": "string" } }, "required": [ "version", "planApproval", "defaultBot", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes your settings. Send the `version` that you read as `expectedVersion`. If they changed since then, the change fails with SettingsConflict.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "planApproval": { "anyOf": [ { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, { "type": "null" } ] }, "defaultBot": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/triggers": { "get": { "tags": [ "Triggers" ], "operationId": "triggers.listTriggers", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, { "type": "null" } ] }, "webhook": { "type": "boolean" }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lastFiredAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "bot", "prompt", "schedule", "webhook", "actor", "enabled", "needsAuthorization", "nextRunAt", "executionId", "lastFiredAt", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the triggers that the caller can read: their own and the shared ones." }, "post": { "tags": [ "Triggers" ], "operationId": "triggers.createTrigger", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, { "type": "null" } ] }, "webhook": { "type": "boolean" }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lastFiredAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "bot", "prompt", "schedule", "webhook", "actor", "enabled", "needsAuthorization", "nextRunAt", "executionId", "lastFiredAt", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "schedule": { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, "shared": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "prompt" ], "additionalProperties": false } } }, "required": true } } }, "/v1/triggers/{triggerId}": { "get": { "tags": [ "Triggers" ], "operationId": "triggers.getTrigger", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, { "type": "null" } ] }, "webhook": { "type": "boolean" }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lastFiredAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "bot", "prompt", "schedule", "webhook", "actor", "enabled", "needsAuthorization", "nextRunAt", "executionId", "lastFiredAt", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Triggers" ], "operationId": "triggers.updateTrigger", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, { "type": "null" } ] }, "webhook": { "type": "boolean" }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "lastFiredAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "owner", "bot", "prompt", "schedule", "webhook", "actor", "enabled", "needsAuthorization", "nextRunAt", "executionId", "lastFiredAt", "revision", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes a trigger and clears needsAuthorization. The caller becomes its actor, so the new tasks work for the caller.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "prompt": { "type": "string", "minLength": 1, "maxLength": 20000 }, "schedule": { "anyOf": [ { "type": "object", "properties": { "cron": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 100 } }, "required": [ "cron" ], "additionalProperties": false }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "expected" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Triggers" ], "operationId": "triggers.deleteTrigger", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/triggers/{triggerId}/webhook": { "put": { "tags": [ "Triggers" ], "operationId": "triggers.setTriggerWebhook", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "url", "secret" ], "additionalProperties": false } } } }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Makes a new webhook secret. The old secret stops working. The caller becomes the actor of the trigger." }, "delete": { "tags": [ "Triggers" ], "operationId": "triggers.removeTriggerWebhook", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "TriggerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TriggerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TriggerNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | TriggerConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/TriggerConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TriggerStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/hooks/triggers/{triggerId}": { "post": { "tags": [ "Trigger webhooks" ], "operationId": "triggerHooks.fireTrigger", "parameters": [ { "name": "triggerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "authorization", "in": "header", "schema": { "type": "string" }, "required": true }, { "name": "idempotency-key", "in": "header", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "executionId", "commandKey", "sequence", "delegation" ], "additionalProperties": false } } } }, "401": { "description": "TriggerHookDenied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerHookDeniedEncoded" } } } }, "403": { "description": "ExecutionForbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" } } } }, "404": { "description": "ExecutionNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | TriggerInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/TriggerInvalidEncoded" } ] } } } }, "503": { "description": "ExecutionUnavailable | TriggerStorageUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/TriggerStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives the task of the trigger to its Bot. Send `Authorization: Bearer `. The JSON body goes to the Bot as data, not as instructions. The task works for the actor of the trigger.", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true } } }, "/v1/organization/channels": { "get": { "tags": [ "Channels" ], "operationId": "channels.listChannels", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "name": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "linkPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "signingSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string" }, "appSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "verificationToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "encryptKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string" }, "secret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "endpoint", "secret" ], "additionalProperties": false } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "webhookUrl": { "type": "string" } }, "required": [ "id", "kind", "name", "bot", "actor", "enabled", "needsAuthorization", "linkPath", "credentials", "executionId", "version", "createdAt", "updatedAt", "webhookUrl" ], "additionalProperties": false } } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Channels" ], "operationId": "channels.createChannel", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "name": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "linkPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "signingSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string" }, "appSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "verificationToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "encryptKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string" }, "secret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "endpoint", "secret" ], "additionalProperties": false } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "webhookUrl": { "type": "string" } }, "required": [ "id", "kind", "name", "bot", "actor", "enabled", "needsAuthorization", "linkPath", "credentials", "executionId", "version", "createdAt", "updatedAt", "webhookUrl" ], "additionalProperties": false } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Saves a Channel and starts its configuration execution. The caller becomes its actor. Read executionId to check registration.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "signingSecret": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string", "minLength": 1, "maxLength": 200 }, "appSecret": { "type": "string", "minLength": 1, "maxLength": 4096 }, "verificationToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "encryptKey": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "kind", "endpoint" ], "additionalProperties": false } ] }, "linkPath": { "type": "string", "maxLength": 4096 }, "enabled": { "type": "boolean" } }, "required": [ "commandKey", "name", "bot", "credentials" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/channels/{channelId}": { "get": { "tags": [ "Channels" ], "operationId": "channels.getChannel", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "name": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "linkPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "signingSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string" }, "appSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "verificationToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "encryptKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string" }, "secret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "endpoint", "secret" ], "additionalProperties": false } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "webhookUrl": { "type": "string" } }, "required": [ "id", "kind", "name", "bot", "actor", "enabled", "needsAuthorization", "linkPath", "credentials", "executionId", "version", "createdAt", "updatedAt", "webhookUrl" ], "additionalProperties": false } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Channels" ], "operationId": "channels.updateChannel", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "name": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "linkPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "signingSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string" }, "appSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "verificationToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "encryptKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string" }, "secret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "endpoint", "secret" ], "additionalProperties": false } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "webhookUrl": { "type": "string" } }, "required": [ "id", "kind", "name", "bot", "actor", "enabled", "needsAuthorization", "linkPath", "credentials", "executionId", "version", "createdAt", "updatedAt", "webhookUrl" ], "additionalProperties": false } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes a Channel. The caller becomes its actor and clears needsAuthorization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "signingSecret": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string", "minLength": 1, "maxLength": 200 }, "appSecret": { "type": "string", "minLength": 1, "maxLength": 4096 }, "verificationToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "encryptKey": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "kind", "endpoint" ], "additionalProperties": false } ] }, "linkPath": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "commandKey", "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Channels" ], "operationId": "channels.deleteChannel", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Stops Channel work, then deletes the Channel and its links. Read the returned execution to wait for release. Its Chats stay.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/channels/{channelId}/secret": { "put": { "tags": [ "Channels" ], "operationId": "channels.setChannelSecret", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "secret": { "type": "string" }, "channel": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "name": { "type": "string" }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "actor": { "type": "string" }, "enabled": { "type": "boolean" }, "needsAuthorization": { "type": "boolean" }, "linkPath": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "slack" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "signingSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken", "signingSecret" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "lark" ] }, "domain": { "type": "string", "enum": [ "feishu", "lark" ] }, "appId": { "type": "string" }, "appSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "verificationToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "encryptKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "domain", "appId", "appSecret", "verificationToken", "encryptKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "telegram" ] }, "botToken": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "botToken" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "endpoint": { "type": "string" }, "secret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "endpoint", "secret" ], "additionalProperties": false } ] }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "webhookUrl": { "type": "string" } }, "required": [ "id", "kind", "name", "bot", "actor", "enabled", "needsAuthorization", "linkPath", "credentials", "executionId", "version", "createdAt", "updatedAt", "webhookUrl" ], "additionalProperties": false } }, "required": [ "secret", "channel" ], "additionalProperties": false } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Makes a new signing secret for a custom Channel. The old secret stops working.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "commandKey", "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/channels/{channelId}/identities": { "get": { "tags": [ "Channels" ], "operationId": "channels.listChannelIdentities", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalUserId": { "type": "string" }, "displayName": { "type": "string" }, "userId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "channel", "externalUserId", "displayName", "userId", "createdAt" ], "additionalProperties": false } } } } }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/channels/{channelId}/identities/{externalUserId}": { "delete": { "tags": [ "Channels" ], "operationId": "channels.deleteChannelIdentity", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "externalUserId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ChannelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelNotFoundEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ChannelConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Unlinks a person. The bot asks them to link again." } }, "/v1/channel-links/{code}": { "get": { "tags": [ "Channel links" ], "operationId": "channelLinks.getChannelLink", "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string", "minLength": 1, "maxLength": 128 }, "channelName": { "type": "string" }, "kind": { "type": "string", "enum": [ "slack", "lark", "telegram", "custom" ] }, "externalUserId": { "type": "string" }, "displayName": { "type": "string" }, "expiresAt": { "type": "number" } }, "required": [ "channel", "channelName", "kind", "externalUserId", "displayName", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChannelLinkInvalid | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelLinkInvalidEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Shows who a link code is for, so the person can check it before they accept." } }, "/v1/channel-links/{code}/accept": { "post": { "tags": [ "Channel links" ], "operationId": "channelLinks.acceptChannelLink", "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "channel": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalUserId": { "type": "string" }, "displayName": { "type": "string" }, "userId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "channel", "externalUserId", "displayName", "userId", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChannelLinkInvalid | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelLinkInvalidEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Links the person on the platform to the caller. A code works only once." } }, "/v1/user/channel-identities": { "get": { "tags": [ "Channel links" ], "operationId": "channelLinks.listMyChannelIdentities", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "channel": { "type": "string", "minLength": 1, "maxLength": 128 }, "externalUserId": { "type": "string" }, "displayName": { "type": "string" }, "userId": { "type": "string" }, "createdAt": { "type": "number" } }, "required": [ "channel", "externalUserId", "displayName", "userId", "createdAt" ], "additionalProperties": false } } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChannelLinkInvalid | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelLinkInvalidEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/user/channel-identities/{channelId}/{externalUserId}": { "delete": { "tags": [ "Channel links" ], "operationId": "channelLinks.deleteMyChannelIdentity", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "externalUserId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ChannelLinkInvalid | ChannelIdentityNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelLinkInvalidEncoded" }, { "$ref": "#/components/schemas/ChannelIdentityNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ChannelsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/hooks/channels/{channelId}": { "post": { "tags": [ "Channel webhooks" ], "operationId": "channelHooks.receiveChannelEvent", "parameters": [ { "name": "channelId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {} } } }, "401": { "description": "ChannelHookDenied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelHookDeniedEncoded" } } } }, "503": { "description": "ChannelsUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ChannelsUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes an event from Slack, Lark, Telegram or a custom Channel. OpenBot checks the signature, answers at once, and does the work later. A custom Channel sends a `CustomEvent` with `X-OpenBot-Timestamp` and `X-OpenBot-Signature: sha256=`.", "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true } } }, "/v1/computer-providers": { "get": { "tags": [ "Computer providers" ], "operationId": "computerProviders.listComputerProviders", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "e2b", "daytona" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandboxDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "sandboxDomain" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "target" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Computer providers that the caller can use: their own and the shared ones." }, "post": { "tags": [ "Computer providers" ], "operationId": "computerProviders.createComputerProvider", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "e2b", "daytona" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandboxDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "sandboxDomain" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "target" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds an account at a Computer provider. OpenBot checks the key with the provider first.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "apiUrl": { "type": "string", "minLength": 1 }, "sandboxDomain": { "type": "string", "minLength": 1, "maxLength": 253 } }, "required": [ "kind", "apiKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "apiUrl": { "type": "string", "minLength": 1 }, "target": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "kind", "apiKey" ], "additionalProperties": false } ] }, "shared": { "type": "boolean" } }, "required": [ "name", "credentials" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computer-providers/{providerId}": { "get": { "tags": [ "Computer providers" ], "operationId": "computerProviders.getComputerProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "e2b", "daytona" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandboxDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "sandboxDomain" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "target" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Computer providers" ], "operationId": "computerProviders.updateComputerProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "e2b", "daytona" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sandboxDomain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "sandboxDomain" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "apiUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "apiKey", "apiUrl", "target" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "e2b" ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "apiUrl": { "type": "string", "minLength": 1 }, "sandboxDomain": { "type": "string", "minLength": 1, "maxLength": 253 } }, "required": [ "kind", "apiKey" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "daytona" ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "apiUrl": { "type": "string", "minLength": 1 }, "target": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "kind", "apiKey" ], "additionalProperties": false } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Computer providers" ], "operationId": "computerProviders.deleteComputerProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes a Computer provider. It fails while Computers still use it." } }, "/v1/computers": { "get": { "tags": [ "Computers" ], "operationId": "computers.listComputers", "parameters": [ { "name": "bot", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Provider" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Connector" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "state": { "type": "string", "enum": [ "starting", "running", "paused", "offline", "failed" ] }, "features": { "type": "object", "properties": { "pause": { "type": "boolean" }, "desktop": { "type": "boolean" }, "ports": { "type": "boolean" } }, "required": [ "pause", "desktop", "ports" ], "additionalProperties": false }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] }, "createdBy": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "id", "name", "owner", "source", "state", "features", "pauseAfter", "createdBy", "version", "createdAt", "updatedAt", "lastActiveAt" ], "additionalProperties": false } } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Computers that the caller can use: their own and the shared ones. With `bot`, it lists only the Computers that this Bot has the right to use." }, "post": { "tags": [ "Computers" ], "operationId": "computers.createComputer", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady | ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Accepts a command to create a Computer and returns its execution receipt. Reuse the command key after a lost reply. A connector Computer stays offline until it connects.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Provider" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Connector" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "desktop": { "type": "boolean" }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] }, "shared": { "type": "boolean" }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "name", "source", "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}": { "get": { "tags": [ "Computers" ], "operationId": "computers.getComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Provider" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Connector" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "state": { "type": "string", "enum": [ "starting", "running", "paused", "offline", "failed" ] }, "features": { "type": "object", "properties": { "pause": { "type": "boolean" }, "desktop": { "type": "boolean" }, "ports": { "type": "boolean" } }, "required": [ "pause", "desktop", "ports" ], "additionalProperties": false }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] }, "createdBy": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "id", "name", "owner", "source", "state", "features", "pauseAfter", "createdBy", "version", "createdAt", "updatedAt", "lastActiveAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Computers" ], "operationId": "computers.updateComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Provider" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Connector" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "state": { "type": "string", "enum": [ "starting", "running", "paused", "offline", "failed" ] }, "features": { "type": "object", "properties": { "pause": { "type": "boolean" }, "desktop": { "type": "boolean" }, "ports": { "type": "boolean" } }, "required": [ "pause", "desktop", "ports" ], "additionalProperties": false }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] }, "createdBy": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "id", "name", "owner", "source", "state", "features", "pauseAfter", "createdBy", "version", "createdAt", "updatedAt", "lastActiveAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Computers" ], "operationId": "computers.deleteComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady | ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Accepts a command to delete a Computer and its sandbox, files and Bot grants. Follow its execution receipt for the result. A lost provider reply waits for a decision.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/bots": { "get": { "tags": [ "Computers" ], "operationId": "computers.listComputerBots", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "computer": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "grantedBy": { "type": "string" }, "grantedAt": { "type": "number" } }, "required": [ "computer", "bot", "grantedBy", "grantedAt" ], "additionalProperties": false } } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Bots that have the right to use a Computer." } }, "/v1/computers/{computerId}/bots/{botId}": { "put": { "tags": [ "Computers" ], "operationId": "computers.grantComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "computer": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "grantedBy": { "type": "string" }, "grantedAt": { "type": "number" } }, "required": [ "computer", "bot", "grantedBy", "grantedAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives a Bot the right to use a Computer. The caller must be able to use the Computer and to change the Bot." }, "delete": { "tags": [ "Computers" ], "operationId": "computers.revokeComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes the right to use a Computer away from a Bot. The Computer stays." } }, "/v1/computers/{computerId}/usage": { "get": { "tags": [ "Computers" ], "operationId": "computers.listComputerUsage", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "computer": { "type": "string", "minLength": 1, "maxLength": 128 }, "startedAt": { "type": "number" }, "endedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "seconds": { "type": "number" } }, "required": [ "computer", "startedAt", "endedAt", "seconds" ], "additionalProperties": false } } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the times when a Computer ran, newest first. The provider bills them. OpenBot only records them." } }, "/v1/computers/{computerId}/pause": { "post": { "tags": [ "Computers" ], "operationId": "computers.pauseComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady | ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Accepts a command to pause a Computer and returns its execution receipt. The provider keeps its files. E2B also keeps its memory and running programs.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/resume": { "post": { "tags": [ "Computers" ], "operationId": "computers.resumeComputer", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | ExecutionForbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady | ExecutionConflict | ExecutionKeyConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/connector-token": { "put": { "tags": [ "Computers" ], "operationId": "computers.setConnectorToken", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Makes a new token for the connector of a connector Computer. The old token stops working, and its connection closes." } }, "/v1/computers/{computerId}/sessions": { "post": { "tags": [ "Computers" ], "operationId": "computers.exec", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "running": { "type": "boolean" }, "exitCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "output": { "type": "string" }, "truncated": { "type": "boolean" } }, "required": [ "session", "running", "exitCode", "signal", "output", "truncated" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Starts a shell command and waits up to yieldTimeMs for it. When it still runs, the answer has a session ID for more input and output. A paused Computer resumes first.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "command": { "type": "string", "minLength": 1, "maxLength": 100000 }, "cwd": { "type": "string", "minLength": 1, "maxLength": 4096 }, "env": { "type": "object", "additionalProperties": { "type": "string" } }, "tty": { "type": "boolean" }, "rows": { "type": "integer", "minimum": 1, "maximum": 1000 }, "cols": { "type": "integer", "minimum": 1, "maximum": 1000 }, "yieldTimeMs": { "type": "integer", "minimum": 250, "maximum": 30000 }, "maxOutputBytes": { "type": "integer", "minimum": 1, "maximum": 1048576 } }, "required": [ "command" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/sessions/{sessionId}/input": { "post": { "tags": [ "Computers" ], "operationId": "computers.writeStdin", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "sessionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "running": { "type": "boolean" }, "exitCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "output": { "type": "string" }, "truncated": { "type": "boolean" } }, "required": [ "session", "running", "exitCode", "signal", "output", "truncated" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Sends text to the stdin of a session, and gives the output since the last call.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chars": { "type": "string", "maxLength": 100000 }, "yieldTimeMs": { "type": "integer", "minimum": 250, "maximum": 30000 }, "maxOutputBytes": { "type": "integer", "minimum": 1, "maximum": 1048576 } }, "required": [ "chars" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/sessions/{sessionId}/resize": { "post": { "tags": [ "Computers" ], "operationId": "computers.resizeSession", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "sessionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "integer", "minimum": 1, "maximum": 1000 }, "cols": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "rows", "cols" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/sessions/{sessionId}": { "delete": { "tags": [ "Computers" ], "operationId": "computers.closeSession", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "sessionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "session": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "running": { "type": "boolean" }, "exitCode": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "output": { "type": "string" }, "truncated": { "type": "boolean" } }, "required": [ "session", "running", "exitCode", "signal", "output", "truncated" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Stops the command of a session, and gives its last output." } }, "/v1/computers/{computerId}/files": { "get": { "tags": [ "Computers" ], "operationId": "computers.readFile", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "path", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "required": true }, { "name": "encoding", "in": "query", "schema": { "type": "string", "enum": [ "utf8", "base64" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 4096 }, "encoding": { "type": "string", "enum": [ "utf8", "base64" ] }, "content": { "type": "string" } }, "required": [ "path", "encoding", "content" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "put": { "tags": [ "Computers" ], "operationId": "computers.writeFile", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Writes a file. OpenBot makes the missing directories.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 4096 }, "encoding": { "type": "string", "enum": [ "utf8", "base64" ] }, "content": { "type": "string" } }, "required": [ "path", "encoding", "content" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Computers" ], "operationId": "computers.removeFile", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "path", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Removes a file, or a directory with everything in it." } }, "/v1/computers/{computerId}/directory": { "get": { "tags": [ "Computers" ], "operationId": "computers.listFiles", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "path", "in": "query", "schema": { "type": "string", "minLength": 1, "maxLength": 4096 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "enum": [ "file", "directory", "link" ] }, "size": { "type": "number" }, "modifiedAt": { "type": "number" } }, "required": [ "name", "kind", "size", "modifiedAt" ], "additionalProperties": false } } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/computers/{computerId}/ports/{port}": { "put": { "tags": [ "Computers" ], "operationId": "computers.openPort", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "port", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "port": { "type": "integer", "minimum": 1, "maximum": 65535 }, "url": { "type": "string" } }, "required": [ "port", "url" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives a port a public HTTPS address." } }, "/v1/computers/{computerId}/desktop/screenshot": { "post": { "tags": [ "Computers" ], "operationId": "computers.takeScreenshot", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "mediaType": { "type": "string", "enum": [ "image/png" ] }, "data": { "type": "string" }, "width": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "height": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "mediaType", "data", "width", "height" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/computers/{computerId}/desktop/actions": { "post": { "tags": [ "Computers" ], "operationId": "computers.useDesktop", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "mediaType": { "type": "string", "enum": [ "image/png" ] }, "data": { "type": "string" }, "width": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "height": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "mediaType", "data", "width", "height" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Does the actions in order, then takes a screenshot.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Click" ] }, "x": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "button": { "type": "string", "enum": [ "left", "right", "middle" ] }, "double": { "type": "boolean" } }, "required": [ "_tag", "x", "y" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Move" ] }, "x": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "x", "y" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Drag" ] }, "fromX": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "fromY": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "toX": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "toY": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "fromX", "fromY", "toX", "toY" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Scroll" ] }, "x": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deltaX": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deltaY": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "_tag", "x", "y", "deltaX", "deltaY" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Type" ] }, "text": { "type": "string", "maxLength": 10000 } }, "required": [ "_tag", "text" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Key" ] }, "keys": { "type": "array", "items": { "type": "string", "maxLength": 32 }, "minItems": 1, "maxItems": 5 } }, "required": [ "_tag", "keys" ], "additionalProperties": false } ] }, "minItems": 1, "maxItems": 50 } }, "required": [ "actions" ], "additionalProperties": false } } }, "required": true } } }, "/v1/computers/{computerId}/desktop/stream": { "post": { "tags": [ "Computers" ], "operationId": "computers.streamDesktop", "parameters": [ { "name": "computerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "url", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives an address where a person can watch and use the desktop." } }, "/v1/computer-pairings/{code}": { "get": { "tags": [ "Computers" ], "operationId": "computers.getComputerPairing", "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "hostname": { "type": "string" }, "os": { "type": "string" }, "arch": { "type": "string" }, "desktop": { "type": "boolean" }, "expiresAt": { "type": "number" } }, "required": [ "code", "hostname", "os", "arch", "desktop", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Shows which machine a pairing code is for, so the person can check it before they approve." } }, "/v1/computer-pairings/{code}/approve": { "post": { "tags": [ "Computers" ], "operationId": "computers.approveComputerPairing", "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Provider" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "template": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "template" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Connector" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "state": { "type": "string", "enum": [ "starting", "running", "paused", "offline", "failed" ] }, "features": { "type": "object", "properties": { "pause": { "type": "boolean" }, "desktop": { "type": "boolean" }, "ports": { "type": "boolean" } }, "required": [ "pause", "desktop", "ports" ], "additionalProperties": false }, "pauseAfter": { "anyOf": [ { "type": "integer", "minimum": 60, "maximum": 604800 }, { "type": "null" } ] }, "createdBy": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "lastActiveAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "id", "name", "owner", "source", "state", "features", "pauseAfter", "createdBy", "version", "createdAt", "updatedAt", "lastActiveAt" ], "additionalProperties": false } } } }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Approves a machine. OpenBot creates a connector Computer for it, and the machine gets its token on its next poll. The Computer belongs to the caller, or to the organization when `shared` is true. When the same machine pairs again, OpenBot keeps its Computer and only changes the token. Only a person can approve.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "shared": { "type": "boolean" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/computer-pairings/{code}/deny": { "post": { "tags": [ "Computers" ], "operationId": "computers.denyComputerPairing", "parameters": [ { "name": "code", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 32 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ComputerInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ComputerNotFound | ComputerPathNotFound | ComputerSessionNotFound | ComputerProviderNotFound | PairingInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerPathNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerSessionNotFoundEncoded" }, { "$ref": "#/components/schemas/ComputerProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/PairingInvalidEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | ComputerProviderInUse | ComputerConflict | ComputerUnsupported | ComputerNotReady", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/ComputerProviderInUseEncoded" }, { "$ref": "#/components/schemas/ComputerConflictEncoded" }, { "$ref": "#/components/schemas/ComputerUnsupportedEncoded" }, { "$ref": "#/components/schemas/ComputerNotReadyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "ComputerProviderFailed | ComputerExecutionFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputerProviderFailedEncoded" }, { "$ref": "#/components/schemas/ComputerExecutionFailedEncoded" } ] } } } }, "503": { "description": "ComputersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Denies a machine. Its pairing ends at once." } }, "/v1/hooks/computers/pairings": { "post": { "tags": [ "Computer connectors" ], "operationId": "computerHooks.startPairing", "parameters": [], "security": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "code": { "type": "string" }, "secret": { "type": "string" }, "interval": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "expiresAt": { "type": "number" } }, "required": [ "id", "code", "secret", "interval", "expiresAt" ], "additionalProperties": false } } } }, "404": { "description": "PairingInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairingInvalidEncoded" } } } }, "503": { "description": "ComputersUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Starts a pairing for a machine. The code works for 10 minutes.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "os": { "type": "string" }, "arch": { "type": "string" }, "desktop": { "type": "boolean" }, "hostname": { "type": "string", "minLength": 1, "maxLength": 253 }, "machineId": { "type": "string", "minLength": 8, "maxLength": 128 } }, "required": [ "version", "os", "arch", "desktop", "hostname", "machineId" ], "additionalProperties": false } } }, "required": true } } }, "/v1/hooks/computers/pairings/{pairingId}/poll": { "post": { "tags": [ "Computer connectors" ], "operationId": "computerHooks.pollPairing", "parameters": [ { "name": "pairingId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "authorization", "in": "header", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Approved" ] }, "computer": { "type": "string", "minLength": 1, "maxLength": 128 }, "token": { "type": "string" } }, "required": [ "_tag", "computer", "token" ], "additionalProperties": false } ] } } } }, "404": { "description": "PairingInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PairingInvalidEncoded" } } } }, "503": { "description": "ComputersUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Tells the machine if a person approved it. Send `Authorization: Bearer ` with the secret of the pairing." } }, "/v1/hooks/computers/connect": { "get": { "tags": [ "Computer connectors" ], "operationId": "computerHooks.connectComputer", "parameters": [ { "name": "authorization", "in": "header", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "204": { "description": "" }, "401": { "description": "ConnectorDenied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDeniedEncoded" } } } }, "503": { "description": "ComputersUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComputersUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/secret-providers": { "get": { "tags": [ "Secret providers" ], "operationId": "secretProviders.listSecretProviders", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "onepassword", "bitwarden", "hashicorp" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "mount": { "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "url", "token", "mount", "namespace" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the secret providers that the caller can use: their own and the shared ones." }, "post": { "tags": [ "Secret providers" ], "operationId": "secretProviders.createSecretProvider", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "onepassword", "bitwarden", "hashicorp" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "mount": { "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "url", "token", "mount", "namespace" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds an account at a secret provider. OpenBot checks the token with the provider first.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "url" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 }, "mount": { "type": "string", "minLength": 1, "maxLength": 256 }, "namespace": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "url", "token" ], "additionalProperties": false } ] }, "shared": { "type": "boolean" } }, "required": [ "name", "credentials" ], "additionalProperties": false } } }, "required": true } } }, "/v1/secret-providers/{providerId}": { "get": { "tags": [ "Secret providers" ], "operationId": "secretProviders.getSecretProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "onepassword", "bitwarden", "hashicorp" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "mount": { "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "url", "token", "mount", "namespace" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Secret providers" ], "operationId": "secretProviders.updateSecretProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "kind": { "type": "string", "enum": [ "onepassword", "bitwarden", "hashicorp" ] }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string" }, "token": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "mount": { "type": "string" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "url", "token", "mount", "namespace" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "kind", "name", "owner", "credentials", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "credentials": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "onepassword" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "url", "token" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "bitwarden" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "kind", "url" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "hashicorp" ] }, "url": { "type": "string", "minLength": 1 }, "token": { "type": "string", "minLength": 1, "maxLength": 4096 }, "mount": { "type": "string", "minLength": 1, "maxLength": 256 }, "namespace": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "url", "token" ], "additionalProperties": false } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Secret providers" ], "operationId": "secretProviders.deleteSecretProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes a secret provider. It fails while Vault items still read from it." } }, "/v1/vaults": { "get": { "tags": [ "Vaults" ], "operationId": "vaults.listVaults", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "owner", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Vaults that the caller can use: their own and the shared ones." }, "post": { "tags": [ "Vaults" ], "operationId": "vaults.createVault", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "owner", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "shared": { "type": "boolean" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": true } } }, "/v1/vaults/{vaultId}": { "get": { "tags": [ "Vaults" ], "operationId": "vaults.getVault", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "owner", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Vaults" ], "operationId": "vaults.updateVault", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "owner": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Member" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Organization" ] } }, "required": [ "_tag" ], "additionalProperties": false } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "owner", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Vaults" ], "operationId": "vaults.deleteVault", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes a Vault, its items and the rights of all Bots to use it. The secret providers keep their secrets." } }, "/v1/vaults/{vaultId}/items": { "get": { "tags": [ "Vaults" ], "operationId": "vaults.listVaultItems", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "description": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "vault", "name", "description", "source", "fields", "exits", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Vaults" ], "operationId": "vaults.createVaultItem", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "description": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "vault", "name", "description", "source", "fields", "exits", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds an item. For an item of a secret provider, the caller must be able to use the provider, and OpenBot reads the item once to check that its fields are there.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "maxLength": 500 }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 32 }, "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] }, "maxItems": 32 } }, "required": [ "name", "source", "exits" ], "additionalProperties": false } } }, "required": true } } }, "/v1/vaults/{vaultId}/items/{itemId}": { "get": { "tags": [ "Vaults" ], "operationId": "vaults.getVaultItem", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "itemId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "description": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "vault", "name", "description", "source", "fields", "exits", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Vaults" ], "operationId": "vaults.updateVaultItem", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "itemId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "description": { "type": "string" }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] } }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "vault", "name", "description", "source", "fields", "exits", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" }, "description": { "type": "string", "maxLength": 500 }, "source": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Builtin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OnePassword" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "vault", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Bitwarden" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "item": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "provider", "item" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "HashiCorp" ] }, "provider": { "type": "string", "minLength": 1, "maxLength": 128 }, "path": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": [ "_tag", "provider", "path" ], "additionalProperties": false } ] }, "fields": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 32 }, "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "exits": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "App" ] }, "connection": { "type": "string", "minLength": 1, "maxLength": 128 }, "tool": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "_tag", "connection", "tool" ], "additionalProperties": false } ] }, "maxItems": 32 } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Vaults" ], "operationId": "vaults.deleteVaultItem", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "itemId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/vaults/{vaultId}/bots": { "get": { "tags": [ "Vaults" ], "operationId": "vaults.listVaultBots", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "grantedBy": { "type": "string" }, "grantedAt": { "type": "number" } }, "required": [ "vault", "bot", "grantedBy", "grantedAt" ], "additionalProperties": false } } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the Bots that have the right to use a Vault." } }, "/v1/vaults/{vaultId}/bots/{botId}": { "put": { "tags": [ "Vaults" ], "operationId": "vaults.grantVault", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "vault": { "type": "string", "minLength": 1, "maxLength": 128 }, "bot": { "type": "string", "minLength": 1, "maxLength": 128 }, "grantedBy": { "type": "string" }, "grantedAt": { "type": "number" } }, "required": [ "vault", "bot", "grantedBy", "grantedAt" ], "additionalProperties": false } } } }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Gives a Bot the right to use every item of a Vault in Code Mode. The caller must be able to use the Vault and to change the Bot." }, "delete": { "tags": [ "Vaults" ], "operationId": "vaults.revokeVault", "parameters": [ { "name": "vaultId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "botId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "VaultInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "VaultNotFound | VaultItemNotFound | SecretProviderNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/VaultNotFoundEncoded" }, { "$ref": "#/components/schemas/VaultItemNotFoundEncoded" }, { "$ref": "#/components/schemas/SecretProviderNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | SecretProviderInUse | VaultConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/SecretProviderInUseEncoded" }, { "$ref": "#/components/schemas/VaultConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "502": { "description": "SecretProviderFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecretProviderFailedEncoded" } } } }, "503": { "description": "VaultsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/VaultsUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes the right to use a Vault away from a Bot." } }, "/v1/organization/usage": { "get": { "tags": [ "Usage" ], "operationId": "usage.getUsage", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "groupBy", "in": "query", "schema": { "type": "string", "enum": [ "day", "model", "provider", "member", "bot", "token", "source" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "groupBy": { "type": "string", "enum": [ "day", "model", "provider", "member", "bot", "token", "source" ] }, "total": { "type": "object", "properties": { "calls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pendingCalls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unknownCalls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputUncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "outputText": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "outputReasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "costMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "calls", "pendingCalls", "unknownCalls", "inputUncached", "inputCacheRead", "inputCacheWrite", "outputText", "outputReasoning", "costMicros" ], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "calls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pendingCalls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unknownCalls": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputUncached": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "outputText": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "outputReasoning": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "costMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "key", "calls", "pendingCalls", "unknownCalls", "inputUncached", "inputCacheRead", "inputCacheWrite", "outputText", "outputReasoning", "costMicros" ], "additionalProperties": false } } }, "required": [ "from", "to", "groupBy", "total", "items" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds up the tokens and the cost of the model calls in a time range. `groupBy` is `day` when you leave it out." } }, "/v1/organization/usage/events": { "get": { "tags": [ "Usage" ], "operationId": "usage.listUsageEvents", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "confirmed", "unknown" ] }, "startedAt": { "type": "string" }, "reservedMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "estimatedMicros": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "estimatedTokens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "occurredAt": { "type": "string" }, "source": { "type": "string", "enum": [ "turn", "compaction", "judge", "bot_memory", "other" ] }, "chatId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "turnId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "botId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tokenId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] }, "provider": { "type": "string" }, "providerOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "model": { "type": "string" }, "inputUncached": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "inputCacheRead": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "inputCacheWrite": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "outputText": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "priced": { "type": "boolean" }, "costMicros": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "charged": { "type": "boolean" } }, "required": [ "id", "executionId", "status", "startedAt", "reservedMicros", "estimatedMicros", "estimatedTokens", "occurredAt", "source", "chatId", "turnId", "botId", "userId", "tokenId", "provider", "providerOwner", "model", "inputUncached", "inputCacheRead", "inputCacheWrite", "outputText", "outputReasoning", "priced", "costMicros", "charged" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists model calls, the newest first. Send `next` as `after` to get the next page." } }, "/v1/organization/credits": { "get": { "tags": [ "Usage" ], "operationId": "usage.getCredits", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "balanceMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "grants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "amountMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "amountMicros", "note", "createdBy", "createdAt" ], "additionalProperties": false } } }, "required": [ "enabled", "balanceMicros", "grants" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/budgets": { "get": { "tags": [ "Budgets" ], "operationId": "budgets.listBudgets", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "organization", "member", "bot", "token" ] }, "scopeId": { "type": "string" }, "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] }, "periodStart": { "type": "string" }, "spentMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "exceeded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "scope", "scopeId", "period", "limitMicros", "mode", "periodStart", "spentMicros", "exceeded", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | BudgetInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/BudgetInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BudgetNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BudgetConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BudgetConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Budgets" ], "operationId": "budgets.createBudget", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "organization", "member", "bot", "token" ] }, "scopeId": { "type": "string" }, "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] }, "periodStart": { "type": "string" }, "spentMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "exceeded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "scope", "scopeId", "period", "limitMicros", "mode", "periodStart", "spentMicros", "exceeded", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | BudgetInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/BudgetInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BudgetNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BudgetConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BudgetConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a budget. Each scope can have one budget for each period.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "organization", "member", "bot", "token" ] }, "scopeId": { "type": "string", "minLength": 1, "maxLength": 200 }, "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] } }, "required": [ "scope", "period", "limitMicros", "mode" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/budgets/{budgetId}": { "get": { "tags": [ "Budgets" ], "operationId": "budgets.getBudget", "parameters": [ { "name": "budgetId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "organization", "member", "bot", "token" ] }, "scopeId": { "type": "string" }, "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] }, "periodStart": { "type": "string" }, "spentMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "exceeded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "scope", "scopeId", "period", "limitMicros", "mode", "periodStart", "spentMicros", "exceeded", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | BudgetInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/BudgetInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BudgetNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BudgetConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BudgetConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Budgets" ], "operationId": "budgets.updateBudget", "parameters": [ { "name": "budgetId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "scope": { "type": "string", "enum": [ "organization", "member", "bot", "token" ] }, "scopeId": { "type": "string" }, "period": { "type": "string", "enum": [ "day", "month" ] }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] }, "periodStart": { "type": "string" }, "spentMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "exceeded": { "type": "boolean" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "scope", "scopeId", "period", "limitMicros", "mode", "periodStart", "spentMicros", "exceeded", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "UsageQueryInvalid | BudgetInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/BudgetInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BudgetNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BudgetConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BudgetConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limitMicros": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mode": { "type": "string", "enum": [ "hard", "soft" ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Budgets" ], "operationId": "budgets.deleteBudget", "parameters": [ { "name": "budgetId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "UsageQueryInvalid | BudgetInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsageQueryInvalidEncoded" }, { "$ref": "#/components/schemas/BudgetInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "BudgetNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | BudgetConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/BudgetConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "BillingUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/BillingUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-operations/{id}": { "get": { "tags": [ "App operations" ], "operationId": "appOperations.get", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": {} }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "request": { "type": "object" } }, "required": [ "_tag", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false } }, "required": [ "_tag", "failure" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "executionId", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result", "failure", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/app-operations": { "get": { "tags": [ "App operations" ], "operationId": "appOperations.list", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": {} }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "request": { "type": "object" } }, "required": [ "_tag", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false } }, "required": [ "_tag", "failure" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "executionId", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result", "failure", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-operations/{id}/inputs": { "post": { "tags": [ "App operations" ], "operationId": "appOperations.respond", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "responses": { "type": "object" } }, "required": [ "commandKey", "round", "responses" ], "additionalProperties": false } } }, "required": true } } }, "/v1/code-runs/{id}": { "get": { "tags": [ "Code runs" ], "operationId": "codeRuns.get", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "binding": { "type": "string" }, "app": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": {} }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "request": { "type": "object" } }, "required": [ "_tag", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false } }, "required": [ "_tag", "failure" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "executionId", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result", "failure", "createdAt", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "rejection": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } }, "required": [ "name", "message" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "index", "binding", "app", "rejection" ], "additionalProperties": false } }, "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "code": { "type": "string", "minLength": 1, "maxLength": 100000 }, "reason": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "value": {}, "logs": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "value", "logs" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "reason": { "type": "string", "enum": [ "Error", "Timeout", "Memory", "OutputTooLarge", "ReplayMismatch", "Cancelled", "Unavailable" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, "logs": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "reason", "failure", "logs" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "calls", "id", "executionId", "chat", "turn", "callId", "code", "reason", "status", "failure", "result", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/chats/{chatId}/code-runs": { "get": { "tags": [ "Code runs" ], "operationId": "codeRuns.list", "parameters": [ { "name": "chatId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "calls": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "binding": { "type": "string" }, "app": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "toolName": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "arguments": { "type": "object" }, "readOnly": { "type": "boolean" }, "round": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "result": {} }, "required": [ "_tag", "result" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InputRequired" ] }, "request": { "type": "object" } }, "required": [ "_tag", "request" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false } }, "required": [ "_tag", "failure" ], "additionalProperties": false }, { "type": "null" } ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "executionId", "chat", "turn", "callId", "toolName", "source", "arguments", "readOnly", "round", "status", "result", "failure", "createdAt", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "rejection": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" } }, "required": [ "name", "message" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "index", "binding", "app", "rejection" ], "additionalProperties": false } }, "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "chat": { "type": "string" }, "turn": { "type": "string" }, "callId": { "type": "string" }, "code": { "type": "string", "minLength": 1, "maxLength": 100000 }, "reason": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Completed" ] }, "value": {}, "logs": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "value", "logs" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Failed" ] }, "reason": { "type": "string", "enum": [ "Error", "Timeout", "Memory", "OutputTooLarge", "ReplayMismatch", "Cancelled", "Unavailable" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, "logs": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "reason", "failure", "logs" ], "additionalProperties": false }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "calls", "id", "executionId", "chat", "turn", "callId", "code", "reason", "status", "failure", "result", "createdAt", "updatedAt" ], "additionalProperties": false } } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-operations/{operationId}/view": { "post": { "tags": [ "App views" ], "operationId": "appViews.open", "parameters": [ { "name": "operationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 }, "readOnly": { "type": "boolean" }, "chat": { "type": "string" }, "turn": { "type": "string" }, "item": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "interaction": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "context": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "revision", "context" ], "additionalProperties": false }, "resource": { "type": "object", "properties": { "uri": { "type": "string" }, "mimeType": { "type": "string", "enum": [ "text/html;profile=mcp-app" ] }, "html": { "type": "string", "minLength": 1 }, "prefersBorder": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "uri", "mimeType", "html" ], "additionalProperties": false }, "tools": { "type": "array", "items": { "type": "object" } }, "arguments": { "type": "object" }, "result": { "type": "object" } }, "required": [ "id", "operationId", "readOnly", "chat", "turn", "item", "source", "interaction", "resource", "tools", "arguments" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string" }, "itemId": { "type": "string" } }, "required": [ "chatId", "itemId" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-views/{viewId}": { "get": { "tags": [ "App views" ], "operationId": "appViews.get", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "operationId": { "type": "string", "minLength": 1, "maxLength": 128 }, "readOnly": { "type": "boolean" }, "chat": { "type": "string" }, "turn": { "type": "string" }, "item": { "type": "string" }, "source": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "connectionName": { "type": "string" }, "cardUrl": { "type": "string" }, "appName": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": [ "tool", "resource", "template", "prompt" ] }, "name": { "type": "string" }, "definition": {} }, "required": [ "connectionId", "connectionName", "cardUrl", "appName", "remoteIndex", "revision", "kind", "name" ], "additionalProperties": false }, "interaction": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "context": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "revision", "context" ], "additionalProperties": false } }, "required": [ "id", "operationId", "readOnly", "chat", "turn", "item", "source", "interaction" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "delete": { "tags": [ "App views" ], "operationId": "appViews.close", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "" }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-views/{viewId}/read": { "post": { "tags": [ "App views" ], "operationId": "appViews.read", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "tools/list", "resources/list", "resources/templates/list" ] }, "params": { "type": "object" } }, "required": [ "method", "params" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-views/{viewId}/actions": { "post": { "tags": [ "App views" ], "operationId": "appViews.act", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "turn": { "type": "string" } }, "required": [ "executionId", "commandKey", "sequence", "chat", "turn" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "tool" ] }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "minLength": 1 }, "arguments": { "type": "object" } }, "required": [ "kind", "commandKey", "name", "arguments" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "resource" ] }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "uri": { "type": "string", "minLength": 1 } }, "required": [ "kind", "commandKey", "uri" ], "additionalProperties": false } ] } } }, "required": true } } }, "/v1/app-views/{viewId}/context": { "put": { "tags": [ "App views" ], "operationId": "appViews.confirmContext", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "context": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "revision", "context" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "context": { "type": "object" } }, "required": [ "revision", "context" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-operations/{operationId}/interaction": { "get": { "tags": [ "App views" ], "operationId": "appViews.interaction", "parameters": [ { "name": "operationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "chatId", "in": "query", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "context": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "revision", "context" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-views/{viewId}/messages": { "post": { "tags": [ "App views" ], "operationId": "appViews.message", "parameters": [ { "name": "viewId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "chat": { "type": "string" }, "turn": { "type": "string" } }, "required": [ "executionId", "commandKey", "sequence", "chat", "turn" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/ChatModelInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound | ChatNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" }, { "$ref": "#/components/schemas/ChatNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/AppViewUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "$ref": "#/components/schemas/ChatStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "content": { "type": "object" } }, "required": [ "commandKey", "content" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-experience/export": { "get": { "tags": [ "App transfer and reset" ], "operationId": "appExperience.export", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "openbot-apps-v1" ] }, "apps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "cardUrl", "remoteIndex" ], "additionalProperties": false }, "maxItems": 30 } }, "required": [ "format", "apps" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/app-experience/import": { "post": { "tags": [ "App transfer and reset" ], "operationId": "appExperience.import", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "entry": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "cardUrl", "remoteIndex" ], "additionalProperties": false }, "draft": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "input": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "number" }, "imported": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "remoteIndex" ], "additionalProperties": false }, "discovery": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Single" ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidate", "issues" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Multiple" ] }, "candidates": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } ], "minItems": 2, "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidates", "issues" ], "additionalProperties": false } ] } }, "required": [ "id", "revision", "input", "expiresAt", "discovery" ], "additionalProperties": false }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "entry", "draft", "error" ], "additionalProperties": false } } }, "required": [ "entries" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": [ "openbot-apps-v1" ] }, "apps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "cardUrl", "remoteIndex" ], "additionalProperties": false }, "maxItems": 30 } }, "required": [ "format", "apps" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-experience/reset": { "post": { "tags": [ "App transfer and reset" ], "operationId": "appExperience.reset", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/app-experience/resets/{executionId}": { "get": { "tags": [ "App transfer and reset" ], "operationId": "appExperience.getReset", "parameters": [ { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "execution": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false }, "connections": { "type": "array", "items": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "execution": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false } }, "required": [ "connectionId", "execution" ], "additionalProperties": false } } }, "required": [ "execution", "connections" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/connections/{connectionId}/executions/{executionId}": { "get": { "tags": [ "Connections" ], "operationId": "connections.getConnectionExecution", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true }, { "name": "executionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "execution": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "resource": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "id": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "kind", "id" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "queued", "running", "waiting", "cancelling", "completed", "failed", "cancelled", "interrupted", "outcome_unknown" ] }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "failure": { "anyOf": [ { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "resource", "status", "sequence", "createdAt", "updatedAt", "failure" ], "additionalProperties": false }, "result": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Updated" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "connectionId", "revision" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Verified" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "capabilities": { "type": "object", "properties": { "protocolVersion": { "type": "string" }, "tools": { "type": "array", "items": { "type": "object" } }, "resources": { "type": "array", "items": { "type": "object" } }, "resourceTemplates": { "type": "array", "items": { "type": "object" } }, "prompts": { "type": "array", "items": { "type": "object" } } }, "required": [ "protocolVersion", "tools", "resources", "resourceTemplates", "prompts" ], "additionalProperties": false } }, "required": [ "_tag", "connectionId", "revision", "capabilities" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unavailable" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "connectionId", "revision" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "execution", "result" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/connections/manual": { "post": { "tags": [ "Connections" ], "operationId": "connections.createManualConnection", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoint": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingConfiguration" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingAuthorization" ] }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unverified" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Available" ] }, "checkedAt": { "type": "number" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "checkedAt", "revision" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationExpired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "NeedsRevalidation" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CleanupPending" ] }, "stage": { "type": "string", "enum": [ "Credentials", "Connection" ] } }, "required": [ "_tag", "stage" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Restricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false } ] } }, "required": [ "id", "name", "cardUrl", "card", "endpoint", "remoteIndex", "sources", "configuration", "enabled", "revision", "availability" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "type": "string", "maxLength": 80 }, "url": { "type": "string" }, "transport": { "type": "string", "enum": [ "streamable-http" ] }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": [ "id", "name", "url", "transport", "headers" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connections/{connectionId}/manual": { "put": { "tags": [ "Connections" ], "operationId": "connections.updateManualConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "maxLength": 80 }, "url": { "type": "string" }, "transport": { "type": "string", "enum": [ "streamable-http" ] }, "headers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "revision", "name", "url", "transport", "headers", "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connections/{connectionId}/verify": { "post": { "tags": [ "Connections" ], "operationId": "connections.verifyConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connections/{connectionId}/refresh": { "post": { "tags": [ "Connections" ], "operationId": "connections.refreshConnectionAuthorization", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connections/{connectionId}/revalidate": { "post": { "tags": [ "Connections" ], "operationId": "connections.revalidateConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "draftId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "confirmed": { "type": "boolean", "enum": [ true ] }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "revision", "draftId", "remoteIndex", "values", "confirmed", "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connections": { "get": { "tags": [ "Connections" ], "operationId": "connections.listConnections", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoint": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingConfiguration" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingAuthorization" ] }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unverified" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Available" ] }, "checkedAt": { "type": "number" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "checkedAt", "revision" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationExpired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "NeedsRevalidation" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CleanupPending" ] }, "stage": { "type": "string", "enum": [ "Credentials", "Connection" ] } }, "required": [ "_tag", "stage" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Restricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false } ] } }, "required": [ "id", "name", "cardUrl", "card", "endpoint", "remoteIndex", "sources", "configuration", "enabled", "revision", "availability" ], "additionalProperties": false } } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Connections" ], "operationId": "connections.createConnection", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoint": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingConfiguration" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingAuthorization" ] }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unverified" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Available" ] }, "checkedAt": { "type": "number" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "checkedAt", "revision" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationExpired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "NeedsRevalidation" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CleanupPending" ] }, "stage": { "type": "string", "enum": [ "Credentials", "Connection" ] } }, "required": [ "_tag", "stage" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Restricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false } ] } }, "required": [ "id", "name", "cardUrl", "card", "endpoint", "remoteIndex", "sources", "configuration", "enabled", "revision", "availability" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "draftId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "cardUrl": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "maxLength": 80 }, "values": { "type": "object", "additionalProperties": { "type": "string" } }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "draftId", "revision", "cardUrl", "remoteIndex", "name", "values", "confirmed" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connection-drafts": { "post": { "tags": [ "Connections" ], "operationId": "connections.prepareConnection", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "input": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "number" }, "imported": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "remoteIndex" ], "additionalProperties": false }, "discovery": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Single" ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidate", "issues" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Multiple" ] }, "candidates": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } ], "minItems": 2, "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidates", "issues" ], "additionalProperties": false } ] } }, "required": [ "id", "revision", "input", "expiresAt", "discovery" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "string", "minLength": 1 } }, "required": [ "input" ], "additionalProperties": false } } }, "required": true } } }, "/v1/connection-drafts/{draftId}": { "get": { "tags": [ "Connections" ], "operationId": "connections.getConnectionDraft", "parameters": [ { "name": "draftId", "in": "path", "schema": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "input": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "number" }, "imported": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "remoteIndex" ], "additionalProperties": false }, "discovery": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Single" ] }, "candidate": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidate", "issues" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Multiple" ] }, "candidates": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false }, { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } ], "minItems": 2, "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoints": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remote": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "requirements": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isSecret": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "key", "isSecret" ], "additionalProperties": false } } }, "required": [ "index", "remote", "requirements" ], "additionalProperties": false } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } } }, "required": [ "cardUrl", "card", "endpoints", "sources" ], "additionalProperties": false } }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "candidates", "issues" ], "additionalProperties": false } ] } }, "required": [ "id", "revision", "input", "expiresAt", "discovery" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/connections/{connectionId}": { "get": { "tags": [ "Connections" ], "operationId": "connections.getConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string", "maxLength": 80 }, "cardUrl": { "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "card": { "type": "object", "properties": { "$schema": { "type": "string", "enum": [ "https://static.modelcontextprotocol.io/schemas/v1/server-card.schema.json" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 200 }, "version": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 100 }, "title": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repository": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string" }, "source": { "type": "string" }, "subfolder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "url", "source" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, { "type": "null" } ] }, "icons": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "src": { "type": "string" }, "mimeType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizes": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark" ] }, { "type": "null" } ] } }, "required": [ "src" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "remotes": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "streamable-http", "sse" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string" }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] } }, "required": [ "name" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "variables": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isRequired": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isSecret": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "string", "number", "boolean", "filepath" ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "choices": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "supportedProtocolVersions": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "type", "url" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] } }, { "type": "null" } ] }, "_meta": { "anyOf": [ { "type": "object" }, { "type": "null" } ] } }, "required": [ "$schema", "name", "version", "description" ], "allOf": [ { "type": "object", "additionalProperties": {} } ] }, "endpoint": { "type": "string" }, "remoteIndex": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sources": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "input", "page", "catalog", "card", "endpoint", "manual" ] }, "url": { "type": "string" }, "originalInput": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "role", "url" ], "additionalProperties": false } }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingConfiguration" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PendingAuthorization" ] }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "scopes" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Unverified" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Available" ] }, "checkedAt": { "type": "number" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "checkedAt", "revision" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthorizationExpired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "NeedsRevalidation" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "CleanupPending" ] }, "stage": { "type": "string", "enum": [ "Credentials", "Connection" ] } }, "required": [ "_tag", "stage" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Restricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false } ] } }, "required": [ "id", "name", "cardUrl", "card", "endpoint", "remoteIndex", "sources", "configuration", "enabled", "revision", "availability" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "put": { "tags": [ "Connections" ], "operationId": "connections.updateConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "maxLength": 80 }, "enabled": { "type": "boolean" }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "revision", "name", "enabled", "commandKey" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Connections" ], "operationId": "connections.deleteConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 }, "sequence": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "executionId", "commandKey", "sequence" ], "additionalProperties": false } } } }, "400": { "description": "ExperienceInputInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceInputInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "AppRestricted | ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppRestrictedEncoded" }, { "$ref": "#/components/schemas/ExecutionForbiddenEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ExperienceNotFound | ExecutionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceNotFoundEncoded" }, { "$ref": "#/components/schemas/ExecutionNotFoundEncoded" } ] } } } }, "409": { "description": "ConnectionCleanupPending | ConnectionConflict | ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConnectionCleanupPendingEncoded" }, { "$ref": "#/components/schemas/ConnectionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionConflictEncoded" }, { "$ref": "#/components/schemas/ExecutionKeyConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "422": { "description": "AppDiscoveryFailed | ConnectionConfigurationInvalid | AppAuthorizationFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AppDiscoveryFailedEncoded" }, { "$ref": "#/components/schemas/ConnectionConfigurationInvalidEncoded" }, { "$ref": "#/components/schemas/AppAuthorizationFailedEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExperienceStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ExecutionUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "commandKey": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "commandKey" ], "additionalProperties": false } } }, "required": true } } }, "/auth/session": { "get": { "tags": [ "Account" ], "operationId": "account.session", "parameters": [], "security": [ { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "profile": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "emailVerified": { "type": "boolean" } }, "additionalProperties": false }, "memberships": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } } }, "required": [ "organizationId", "name", "status", "roles" ], "additionalProperties": false } }, "platformAdmin": { "type": "boolean" }, "expiresAt": { "type": "string" } }, "required": [ "userId", "profile", "memberships", "platformAdmin", "expiresAt" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "MembershipRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipRequiredEncoded" } } } }, "503": { "description": "AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/auth/sign-in": { "post": { "tags": [ "Sign-in" ], "operationId": "signIn.signIn", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "403": { "description": "ForbiddenOrigin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } } } }, "503": { "description": "SignInUnavailable | AuthenticationUnavailable | SettingsUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SignInUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320 }, "returnTo": { "type": "string", "maxLength": 4096 } }, "additionalProperties": false } } }, "required": true } } }, "/v1/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listOrganizations", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the organizations where you are a member. A user token sees only its own organization." }, "post": { "tags": [ "Organizations" ], "operationId": "organizations.createOrganization", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "OrganizationCreationDisabled | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationCreationDisabledEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Creates an organization. You become its Super Administrator. The platform settings say who can do this.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "name" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organizations/{organizationId}/membership": { "delete": { "tags": [ "Organizations" ], "operationId": "organizations.leaveOrganization", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "MemberNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotFoundEncoded" } } } }, "409": { "description": "LastSuperAdministrator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LastSuperAdministratorEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Leaves an organization. Your tokens in it stop working. The last active Super Administrator cannot leave. A user token can only leave its own organization." } }, "/v1/invitations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations.listMyInvitations", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "email": { "type": "string" }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "bot": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "organizationId", "organizationName", "email", "roles", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "InvitationInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationInvalidEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the pending invitations for your verified email." } }, "/v1/invitations/{invitationId}/accept": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.acceptInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "InvitationInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationInvalidEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Joins the organization of the invitation. You need the session cookie, and your verified email must be the email of the invitation. An invitation to use a Bot needs `POST /v1/bot-invitations/accept` instead." } }, "/v1/invitations/{invitationId}/decline": { "post": { "tags": [ "Organizations" ], "operationId": "organizations.declineInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "email": { "type": "string" }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "bot": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "organizationId", "organizationName", "email", "roles", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "InvitationInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationInvalidEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Says no to an invitation. You need the session cookie and the email of the invitation." } }, "/v1/platform/model_providers/{providerId}/oauth/authorizations": { "post": { "tags": [ "Platform" ], "operationId": "platform.startPlatformProviderAuthorization", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "url": { "type": "string" }, "expiresAt": { "type": "string" } }, "required": [ "id", "url", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "redirectUri": { "type": "string", "minLength": 1, "maxLength": 4096 }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "redirectUri", "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/model_providers/{providerId}/oauth/authorizations/{authorizationId}/complete": { "post": { "tags": [ "Platform" ], "operationId": "platform.completePlatformProviderAuthorization", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "authorizationId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callbackUrl": { "type": "string", "minLength": 1, "maxLength": 16384 } }, "required": [ "callbackUrl" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/model_providers/{providerId}/oauth": { "delete": { "tags": [ "Platform" ], "operationId": "platform.disconnectPlatformProviderOAuth", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/model_providers/{providerId}/available_models": { "get": { "tags": [ "Platform" ], "operationId": "platform.getPlatformProviderAvailableModels", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "name", "reasoningEfforts", "serviceTiers" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/settings": { "get": { "tags": [ "Platform" ], "operationId": "platform.getPlatformSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "publicOrigin": { "type": "string", "minLength": 1 }, "identityProvider": { "anyOf": [ { "type": "object", "properties": { "issuer": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "issuer", "clientId", "clientSecret" ], "additionalProperties": false }, { "type": "null" } ] }, "organizationCreation": { "type": "string", "enum": [ "anyone", "platform_admins" ] }, "ceiling": { "type": "string" }, "appRestrictions": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, "maxItems": 1000 }, "codeMode": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "timeoutMs": { "type": "integer", "minimum": 100, "maximum": 600000 }, "memoryMb": { "type": "integer", "minimum": 8, "maximum": 1024 }, "outputBytes": { "type": "integer", "minimum": 1024, "maximum": 4194304 } }, "required": [ "enabled", "timeoutMs", "memoryMb", "outputBytes" ], "additionalProperties": false }, "rateLimit": { "type": "object", "properties": { "requestsPerMinute": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1000000 }, { "type": "null" } ] } }, "required": [ "requestsPerMinute" ], "additionalProperties": false }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false }, "files": { "type": "object", "properties": { "storage": { "anyOf": [ { "type": "object", "properties": { "endpoint": { "type": "string", "minLength": 1 }, "publicEndpoint": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "region": { "type": "string", "minLength": 1, "maxLength": 64 }, "bucket": { "type": "string" }, "accessKeyId": { "type": "string", "minLength": 1, "maxLength": 256 }, "forcePathStyle": { "type": "boolean" }, "secretAccessKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "endpoint", "publicEndpoint", "region", "bucket", "accessKeyId", "forcePathStyle", "secretAccessKey" ], "additionalProperties": false }, { "type": "null" } ] }, "uploads": { "type": "object", "properties": { "server": { "type": "boolean" }, "direct": { "type": "boolean" } }, "required": [ "server", "direct" ], "additionalProperties": false }, "maxBytes": { "type": "integer", "minimum": 1, "maximum": 5368709120 }, "quotaBytes": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1125899906842624 }, { "type": "null" } ] }, "mediaTypes": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 }, "maxItems": 100 }, "unusedMs": { "type": "integer", "minimum": 60000, "maximum": 31536000000 } }, "required": [ "storage", "uploads", "maxBytes", "quotaBytes", "mediaTypes", "unusedMs" ], "additionalProperties": false }, "updatedAt": { "type": "string" } }, "required": [ "version", "publicOrigin", "identityProvider", "organizationCreation", "ceiling", "appRestrictions", "codeMode", "rateLimit", "tokenRate", "files", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsInvalidEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Platform" ], "operationId": "platform.updatePlatformSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "publicOrigin": { "type": "string", "minLength": 1 }, "identityProvider": { "anyOf": [ { "type": "object", "properties": { "issuer": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "issuer", "clientId", "clientSecret" ], "additionalProperties": false }, { "type": "null" } ] }, "organizationCreation": { "type": "string", "enum": [ "anyone", "platform_admins" ] }, "ceiling": { "type": "string" }, "appRestrictions": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, "maxItems": 1000 }, "codeMode": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "timeoutMs": { "type": "integer", "minimum": 100, "maximum": 600000 }, "memoryMb": { "type": "integer", "minimum": 8, "maximum": 1024 }, "outputBytes": { "type": "integer", "minimum": 1024, "maximum": 4194304 } }, "required": [ "enabled", "timeoutMs", "memoryMb", "outputBytes" ], "additionalProperties": false }, "rateLimit": { "type": "object", "properties": { "requestsPerMinute": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1000000 }, { "type": "null" } ] } }, "required": [ "requestsPerMinute" ], "additionalProperties": false }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false }, "files": { "type": "object", "properties": { "storage": { "anyOf": [ { "type": "object", "properties": { "endpoint": { "type": "string", "minLength": 1 }, "publicEndpoint": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "region": { "type": "string", "minLength": 1, "maxLength": 64 }, "bucket": { "type": "string" }, "accessKeyId": { "type": "string", "minLength": 1, "maxLength": 256 }, "forcePathStyle": { "type": "boolean" }, "secretAccessKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false } }, "required": [ "endpoint", "publicEndpoint", "region", "bucket", "accessKeyId", "forcePathStyle", "secretAccessKey" ], "additionalProperties": false }, { "type": "null" } ] }, "uploads": { "type": "object", "properties": { "server": { "type": "boolean" }, "direct": { "type": "boolean" } }, "required": [ "server", "direct" ], "additionalProperties": false }, "maxBytes": { "type": "integer", "minimum": 1, "maximum": 5368709120 }, "quotaBytes": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1125899906842624 }, { "type": "null" } ] }, "mediaTypes": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 }, "maxItems": 100 }, "unusedMs": { "type": "integer", "minimum": 60000, "maximum": 31536000000 } }, "required": [ "storage", "uploads", "maxBytes", "quotaBytes", "mediaTypes", "unusedMs" ], "additionalProperties": false }, "updatedAt": { "type": "string" } }, "required": [ "version", "publicOrigin", "identityProvider", "organizationCreation", "ceiling", "appRestrictions", "codeMode", "rateLimit", "tokenRate", "files", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsInvalidEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the platform settings. Send the `version` that you read as `expectedVersion`. Every instance uses the new settings right away. A new `publicOrigin` signs everyone out and changes the sign-in redirect URI.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "publicOrigin": { "type": "string", "minLength": 1 }, "identityProvider": { "anyOf": [ { "type": "object", "properties": { "issuer": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] } }, "required": [ "issuer", "clientId" ], "additionalProperties": false }, { "type": "null" } ] }, "organizationCreation": { "type": "string", "enum": [ "anyone", "platform_admins" ] }, "ceiling": { "type": "string" }, "appRestrictions": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false }, "maxItems": 1000 }, "codeMode": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "timeoutMs": { "type": "integer", "minimum": 100, "maximum": 600000 }, "memoryMb": { "type": "integer", "minimum": 8, "maximum": 1024 }, "outputBytes": { "type": "integer", "minimum": 1024, "maximum": 4194304 } }, "required": [ "enabled", "timeoutMs", "memoryMb", "outputBytes" ], "additionalProperties": false }, "rateLimit": { "type": "object", "properties": { "requestsPerMinute": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1000000 }, { "type": "null" } ] } }, "required": [ "requestsPerMinute" ], "additionalProperties": false }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false }, "files": { "type": "object", "properties": { "storage": { "anyOf": [ { "type": "object", "properties": { "endpoint": { "type": "string", "minLength": 1 }, "publicEndpoint": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "region": { "type": "string", "minLength": 1, "maxLength": 64 }, "bucket": { "type": "string" }, "accessKeyId": { "type": "string", "minLength": 1, "maxLength": 256 }, "forcePathStyle": { "type": "boolean" }, "secretAccessKey": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "endpoint", "publicEndpoint", "region", "bucket", "accessKeyId", "forcePathStyle" ], "additionalProperties": false }, { "type": "null" } ] }, "uploads": { "type": "object", "properties": { "server": { "type": "boolean" }, "direct": { "type": "boolean" } }, "required": [ "server", "direct" ], "additionalProperties": false }, "maxBytes": { "type": "integer", "minimum": 1, "maximum": 5368709120 }, "quotaBytes": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 1125899906842624 }, { "type": "null" } ] }, "mediaTypes": { "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 255 }, "maxItems": 100 }, "unusedMs": { "type": "integer", "minimum": 60000, "maximum": 31536000000 } }, "additionalProperties": false } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/organizations": { "get": { "tags": [ "Platform" ], "operationId": "platform.listPlatformOrganizations", "parameters": [ { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/organizations/{organizationId}": { "patch": { "tags": [ "Platform" ], "operationId": "platform.updatePlatformOrganization", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "OrganizationNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Suspends an organization or makes it active again. Nobody can use a suspended organization, and its tokens stop working.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "suspended" ] } }, "required": [ "status" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/admins": { "get": { "tags": [ "Platform" ], "operationId": "platform.listPlatformAdmins", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addedAt": { "type": "string" } }, "required": [ "email", "userId", "addedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Platform" ], "operationId": "platform.addPlatformAdmin", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "addedAt": { "type": "string" } }, "required": [ "email", "userId", "addedAt" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320 } }, "required": [ "email" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/admins/{email}": { "delete": { "tags": [ "Platform" ], "operationId": "platform.removePlatformAdmin", "parameters": [ { "name": "email", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "PlatformAdminNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformAdminNotFoundEncoded" } } } }, "409": { "description": "LastPlatformAdmin | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/LastPlatformAdminEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/models": { "get": { "tags": [ "Platform" ], "operationId": "platform.listPlatformModels", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Platform" ], "operationId": "platform.createPlatformModel", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a model of the platform. `availability` says which organizations can use it. A provider must link it before anyone can call it.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false } ] } }, "required": [ "id", "name", "reasoningEfforts", "serviceTiers", "availability" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/models/{modelId}": { "get": { "tags": [ "Platform" ], "operationId": "platform.getPlatformModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Platform" ], "operationId": "platform.updatePlatformModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Platform" ], "operationId": "platform.deletePlatformModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/model_providers": { "get": { "tags": [ "Platform" ], "operationId": "platform.listPlatformModelProviders", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Platform" ], "operationId": "platform.createPlatformModelProvider", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a model provider that the platform pays for. `availability` says which organizations can use it.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "endpoint": { "type": "string", "minLength": 1 }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false }, "maxItems": 200 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false } ] } }, "required": [ "kind", "name", "models", "availability" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/model_providers/{providerId}": { "get": { "tags": [ "Platform" ], "operationId": "platform.getPlatformModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Platform" ], "operationId": "platform.updatePlatformModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "endpoint": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false }, "maxItems": 200 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Platform" ], "operationId": "platform.deletePlatformModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/platform/model_providers/{providerId}/prices": { "get": { "tags": [ "Platform" ], "operationId": "platform.listPlatformModelPrices", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string" }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 }, "effectiveFrom": { "type": "string" } }, "required": [ "model", "timeZone", "tiers", "periods", "effectiveFrom" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the current price of each model of a provider of the platform. Organizations pay this price with their credits." }, "put": { "tags": [ "Platform" ], "operationId": "platform.setPlatformModelPrice", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string" }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 }, "effectiveFrom": { "type": "string" } }, "required": [ "model", "timeZone", "tiers", "periods", "effectiveFrom" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Sets a new price for one model of the provider. The price applies to calls from now on. Old calls keep their cost.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "model", "tiers" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/organizations/{organizationId}/credits": { "get": { "tags": [ "Platform" ], "operationId": "platform.getPlatformOrganizationCredits", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "balanceMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "grants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "amountMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "amountMicros", "note", "createdBy", "createdAt" ], "additionalProperties": false } } }, "required": [ "enabled", "balanceMicros", "grants" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "OrganizationNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Platform" ], "operationId": "platform.updatePlatformOrganizationCredits", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "balanceMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "grants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "amountMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "amountMicros", "note", "createdBy", "createdAt" ], "additionalProperties": false } } }, "required": [ "enabled", "balanceMicros", "grants" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "OrganizationNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Turns the credits of an organization on or off. While they are on, the organization can use the models of the platform only when its balance is more than 0.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } } }, "required": true } } }, "/v1/platform/organizations/{organizationId}/credits/grants": { "post": { "tags": [ "Platform" ], "operationId": "platform.grantPlatformOrganizationCredits", "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "amountMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "id", "amountMicros", "note", "createdBy", "createdAt" ], "additionalProperties": false } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "OrganizationNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "503": { "description": "PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PlatformUnavailableEncoded" }, { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds credits to an organization. A negative amount takes credits back.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amountMicros": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "note": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "amountMicros", "note" ], "additionalProperties": false } } }, "required": true } } }, "/v1/user/tokens": { "get": { "tags": [ "User tokens" ], "operationId": "userTokens.listTokens", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "prefix": { "type": "string" }, "policy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "policy", "createdAt", "expiresAt", "lastUsedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "User tokens" ], "operationId": "userTokens.createToken", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "prefix": { "type": "string" }, "policy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "policy", "createdAt", "expiresAt", "lastUsedAt" ], "additionalProperties": false }, "secret": { "type": "string" } }, "required": [ "token", "secret" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "TokenLimitReached | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenLimitReachedEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "policy": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } } }, "required": true } } }, "/v1/user/tokens/{tokenId}": { "delete": { "tags": [ "User tokens" ], "operationId": "userTokens.revokeToken", "parameters": [ { "name": "tokenId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "TokenNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/tokens/verify": { "get": { "tags": [ "User tokens" ], "operationId": "userTokens.verifyToken", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "caller": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "member" ] }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "tokenId": { "not": {} } }, "required": [ "kind", "userId", "organizationId" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user_token" ] }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "tokenId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "kind", "userId", "organizationId", "tokenId" ], "additionalProperties": false } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "name": { "type": "string" }, "prefix": { "type": "string" }, "policy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "prefix", "policy", "createdAt", "expiresAt", "lastUsedAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "caller", "token" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "TokenStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Shows who the caller is and, for a token, its policy. Every caller can use it." } }, "/v1/organization": { "get": { "tags": [ "Organization" ], "operationId": "organization.getOrganization", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Organization" ], "operationId": "organization.updateOrganization", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "name", "status", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "additionalProperties": false } } }, "required": true } } }, "/v1/organization/members": { "get": { "tags": [ "Organization" ], "operationId": "organization.listMembers", "parameters": [ { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "policy": { "type": "string" }, "joinedAt": { "type": "string" } }, "required": [ "userId", "email", "name", "status", "roles", "policy", "joinedAt" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/members/{userId}": { "get": { "tags": [ "Organization" ], "operationId": "organization.getMember", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "policy": { "type": "string" }, "joinedAt": { "type": "string" } }, "required": [ "userId", "email", "name", "status", "roles", "policy", "joinedAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "MemberNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | LastSuperAdministrator", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/LastSuperAdministratorEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Organization" ], "operationId": "organization.updateMember", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "suspended" ] }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "policy": { "type": "string" }, "joinedAt": { "type": "string" } }, "required": [ "userId", "email", "name", "status", "roles", "policy", "joinedAt" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "MemberNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/MemberNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | LastSuperAdministrator", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/LastSuperAdministratorEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the status, roles or extra policy of a member. A suspended member cannot sign in, and their tokens stop working.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "suspended" ] }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "policy": { "type": "string" } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Organization" ], "operationId": "organization.removeMember", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "MemberNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | LastSuperAdministrator", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/LastSuperAdministratorEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Removes a member and revokes their tokens. If their email domain is still allowed, they join again the next time they sign in. Suspend them to keep them out." } }, "/v1/organization/invitations": { "get": { "tags": [ "Organization" ], "operationId": "organization.listInvitations", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "email": { "type": "string" }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "bot": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "organizationId", "organizationName", "email", "roles", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the invitations of the organization, newest first." }, "post": { "tags": [ "Organization" ], "operationId": "organization.createInvitation", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "email": { "type": "string" }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "declined", "revoked", "expired" ] }, "invitedBy": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "bot": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "organizationId", "organizationName", "email", "roles", "status", "invitedBy", "createdAt", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Invites a person by email. They accept with `POST /v1/invitations/:invitationId/accept` after they sign in with that verified email. An invitation lasts 7 days.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "maxLength": 320 }, "roles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 } }, "required": [ "email" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/invitations/{invitationId}": { "delete": { "tags": [ "Organization" ], "operationId": "organization.revokeInvitation", "parameters": [ { "name": "invitationId", "in": "path", "schema": { "type": "string", "minLength": 1, "maxLength": 128 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "InvitationInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "InvitationNotFound | RoleNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvitationNotFoundEncoded" }, { "$ref": "#/components/schemas/RoleNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Takes back a pending invitation." } }, "/v1/organization/resources": { "get": { "tags": [ "Organization" ], "operationId": "organization.listResources", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "Chat", "File", "Request", "Connection", "App", "Token", "ChannelIdentity", "Bot", "Trigger", "Computer", "ComputerProvider", "Vault", "SecretProvider", "Channel", "Model", "Organization", "Role", "Member", "ModelProvider", "Sso", "AuditLog", "Usage", "Budget", "Platform" ] }, "actions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name", "description" ], "additionalProperties": false } }, "fields": { "type": "array", "items": { "type": "string" } }, "path": { "type": "array", "items": { "type": "string" } } }, "required": [ "kind", "actions", "fields", "path" ], "additionalProperties": false } } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/settings": { "get": { "tags": [ "Organization" ], "operationId": "organization.getSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rulesModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemoryModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemory": { "type": "boolean" }, "requestTimeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "delegationTimeLimitMs": { "type": "integer", "minimum": 60000, "maximum": 2592000000 }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "toolForegroundBudgetMs": { "type": "integer", "minimum": 0, "maximum": 600000 }, "toolMaxDurationMs": { "type": "integer", "minimum": 1000, "maximum": 86400000 }, "maxBackgroundOperations": { "type": "integer", "minimum": 0, "maximum": 100 }, "appReadRules": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string", "minLength": 1 }, "tool": { "type": "string", "minLength": 1 } }, "required": [ "cardUrl", "tool" ], "additionalProperties": false }, "maxItems": 1000 }, "defaultRoles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "joinByDomain": { "type": "boolean" }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false }, "updatedAt": { "type": "string" } }, "required": [ "version", "rulesModel", "botMemoryModel", "botMemory", "requestTimeoutMs", "delegationTimeLimitMs", "planApproval", "toolForegroundBudgetMs", "toolMaxDurationMs", "maxBackgroundOperations", "appReadRules", "defaultRoles", "joinByDomain", "tokenRate", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Organization" ], "operationId": "organization.updateSettings", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rulesModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemoryModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemory": { "type": "boolean" }, "requestTimeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "delegationTimeLimitMs": { "type": "integer", "minimum": 60000, "maximum": 2592000000 }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "toolForegroundBudgetMs": { "type": "integer", "minimum": 0, "maximum": 600000 }, "toolMaxDurationMs": { "type": "integer", "minimum": 1000, "maximum": 86400000 }, "maxBackgroundOperations": { "type": "integer", "minimum": 0, "maximum": 100 }, "appReadRules": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string", "minLength": 1 }, "tool": { "type": "string", "minLength": 1 } }, "required": [ "cardUrl", "tool" ], "additionalProperties": false }, "maxItems": 1000 }, "defaultRoles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "joinByDomain": { "type": "boolean" }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false }, "updatedAt": { "type": "string" } }, "required": [ "version", "rulesModel", "botMemoryModel", "botMemory", "requestTimeoutMs", "delegationTimeLimitMs", "planApproval", "toolForegroundBudgetMs", "toolMaxDurationMs", "maxBackgroundOperations", "appReadRules", "defaultRoles", "joinByDomain", "tokenRate", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SettingsInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "SettingsConflict | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SettingsConflictEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "$ref": "#/components/schemas/SettingsUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes the settings. Send the `version` that you read as `expectedVersion`. If someone changed the settings since then, the change fails with SettingsConflict. Every instance uses the new settings right away.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rulesModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemoryModel": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "botMemory": { "type": "boolean" }, "requestTimeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "delegationTimeLimitMs": { "type": "integer", "minimum": 60000, "maximum": 2592000000 }, "planApproval": { "type": "object", "properties": { "approver": { "type": "string", "enum": [ "chain", "person" ] }, "timeoutMs": { "type": "integer", "minimum": 1000, "maximum": 604800000 }, "onTimeout": { "type": "string", "enum": [ "run", "stay" ] } }, "required": [ "approver", "timeoutMs", "onTimeout" ], "additionalProperties": false }, "toolForegroundBudgetMs": { "type": "integer", "minimum": 0, "maximum": 600000 }, "toolMaxDurationMs": { "type": "integer", "minimum": 1000, "maximum": 86400000 }, "maxBackgroundOperations": { "type": "integer", "minimum": 0, "maximum": 100 }, "appReadRules": { "type": "array", "items": { "type": "object", "properties": { "cardUrl": { "type": "string", "minLength": 1 }, "tool": { "type": "string", "minLength": 1 } }, "required": [ "cardUrl", "tool" ], "additionalProperties": false }, "maxItems": 1000 }, "defaultRoles": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "minItems": 1 }, "joinByDomain": { "type": "boolean" }, "tokenRate": { "type": "object", "properties": { "organization": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "member": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "bot": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] }, "token": { "anyOf": [ { "type": "object", "properties": { "tokensPerSecond": { "type": "integer", "minimum": 1, "maximum": 10000000 }, "burstTokens": { "type": "integer", "minimum": 1, "maximum": 100000000 } }, "required": [ "tokensPerSecond", "burstTokens" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "organization", "member", "bot", "token" ], "additionalProperties": false } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/roles": { "get": { "tags": [ "Organization" ], "operationId": "organization.listRoles", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "name": { "type": "string" }, "description": { "type": "string" }, "builtin": { "type": "boolean" }, "policy": { "type": "string" } }, "required": [ "id", "name", "description", "builtin", "policy" ], "additionalProperties": false } } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the built-in roles and the custom roles of the organization." }, "post": { "tags": [ "Organization" ], "operationId": "organization.createRole", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "name": { "type": "string" }, "description": { "type": "string" }, "builtin": { "type": "boolean" }, "policy": { "type": "string" } }, "required": [ "id", "name", "description", "builtin", "policy" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "RoleNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | RoleInUse | RoleReadOnly", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/RoleInUseEncoded" }, { "$ref": "#/components/schemas/RoleReadOnlyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Creates a custom role. Its policy cannot allow anything that you cannot do yourself.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 1000 }, "policy": { "type": "string" } }, "required": [ "name", "description", "policy" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/roles/{roleId}": { "get": { "tags": [ "Organization" ], "operationId": "organization.getRole", "parameters": [ { "name": "roleId", "in": "path", "schema": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "name": { "type": "string" }, "description": { "type": "string" }, "builtin": { "type": "boolean" }, "policy": { "type": "string" } }, "required": [ "id", "name", "description", "builtin", "policy" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "RoleNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | RoleInUse | RoleReadOnly", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/RoleInUseEncoded" }, { "$ref": "#/components/schemas/RoleReadOnlyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Organization" ], "operationId": "organization.updateRole", "parameters": [ { "name": "roleId", "in": "path", "schema": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "name": { "type": "string" }, "description": { "type": "string" }, "builtin": { "type": "boolean" }, "policy": { "type": "string" } }, "required": [ "id", "name", "description", "builtin", "policy" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "RoleNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | RoleInUse | RoleReadOnly", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/RoleInUseEncoded" }, { "$ref": "#/components/schemas/RoleReadOnlyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes a custom role. Every member with the role gets the new policy at once.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "description": { "type": "string", "maxLength": 1000 }, "policy": { "type": "string" } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Organization" ], "operationId": "organization.deleteRole", "parameters": [ { "name": "roleId", "in": "path", "schema": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "RoleNotFound", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleNotFoundEncoded" } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | RoleInUse | RoleReadOnly", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/RoleInUseEncoded" }, { "$ref": "#/components/schemas/RoleReadOnlyEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Deletes a custom role. It fails with RoleInUse while a member or the default roles use it." } }, "/v1/organization/audit_logs": { "get": { "tags": [ "Organization" ], "operationId": "organization.listAuditLogs", "parameters": [ { "name": "after", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "action", "in": "query", "schema": { "type": "string", "enum": [ "member.joined", "member.updated", "member.removed", "member.left", "invitation.created", "invitation.revoked", "invitation.accepted", "invitation.declined", "bot_member.joined", "bot_member.removed", "organization.created", "organization.updated", "settings.updated", "role.created", "role.updated", "role.deleted", "model.created", "model.updated", "model.deleted", "model_provider.created", "model_provider.updated", "model_provider.deleted", "domain.added", "domain.verified", "domain.removed", "sso_connection.created", "sso_connection.updated", "sso_connection.deleted", "token.created", "token.revoked", "bot.created", "bot.updated", "bot.promoted", "bot.memory.updated", "bot.memory.purged", "bot.memory_bot.updated", "delegation.started", "delegation.completed", "capability.decided", "request.resolved", "grant.created", "grant.revoked", "rule.created", "rule.updated", "trigger.created", "trigger.updated", "trigger.deleted", "trigger.hook_changed", "trigger.fired", "channel.created", "channel.updated", "channel.deleted", "channel.secret_changed", "channel_identity.linked", "channel_identity.unlinked", "computer_provider.created", "computer_provider.updated", "computer_provider.deleted", "computer.created", "computer.updated", "computer.deleted", "computer.paired", "computer.token_changed", "computer.granted", "computer.revoked", "computer.port_opened", "secret_provider.created", "secret_provider.updated", "secret_provider.deleted", "vault.created", "vault.updated", "vault.deleted", "vault.item.created", "vault.item.updated", "vault.item.deleted", "vault.granted", "vault.revoked", "model_price.set", "budget.created", "budget.updated", "budget.deleted", "credits.updated", "credits.granted" ] }, "required": false }, { "name": "actor", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "action": { "type": "string", "enum": [ "member.joined", "member.updated", "member.removed", "member.left", "invitation.created", "invitation.revoked", "invitation.accepted", "invitation.declined", "bot_member.joined", "bot_member.removed", "organization.created", "organization.updated", "settings.updated", "role.created", "role.updated", "role.deleted", "model.created", "model.updated", "model.deleted", "model_provider.created", "model_provider.updated", "model_provider.deleted", "domain.added", "domain.verified", "domain.removed", "sso_connection.created", "sso_connection.updated", "sso_connection.deleted", "token.created", "token.revoked", "bot.created", "bot.updated", "bot.promoted", "bot.memory.updated", "bot.memory.purged", "bot.memory_bot.updated", "delegation.started", "delegation.completed", "capability.decided", "request.resolved", "grant.created", "grant.revoked", "rule.created", "rule.updated", "trigger.created", "trigger.updated", "trigger.deleted", "trigger.hook_changed", "trigger.fired", "channel.created", "channel.updated", "channel.deleted", "channel.secret_changed", "channel_identity.linked", "channel_identity.unlinked", "computer_provider.created", "computer_provider.updated", "computer_provider.deleted", "computer.created", "computer.updated", "computer.deleted", "computer.paired", "computer.token_changed", "computer.granted", "computer.revoked", "computer.port_opened", "secret_provider.created", "secret_provider.updated", "secret_provider.deleted", "vault.created", "vault.updated", "vault.deleted", "vault.item.created", "vault.item.updated", "vault.item.deleted", "vault.granted", "vault.revoked", "model_price.set", "budget.created", "budget.updated", "budget.deleted", "credits.updated", "credits.granted" ] }, "actor": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "member" ] }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "tokenId": { "not": {} } }, "required": [ "kind", "userId", "organizationId" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user_token" ] }, "userId": { "type": "string" }, "organizationId": { "type": "string" }, "tokenId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "kind", "userId", "organizationId", "tokenId" ], "additionalProperties": false } ] }, "resource": { "type": "string" }, "details": { "type": "object" } }, "required": [ "id", "createdAt", "action", "actor", "resource", "details" ], "additionalProperties": false } }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next" ], "additionalProperties": false } } } }, "400": { "description": "OrganizationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OrganizationStorageUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists audit log entries, newest first. `actor` filters by user ID." } }, "/v1/organization/model_providers/{providerId}/oauth/authorizations": { "post": { "tags": [ "Model providers" ], "operationId": "modelProviders.startProviderAuthorization", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "url": { "type": "string" }, "expiresAt": { "type": "string" } }, "required": [ "id", "url", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "redirectUri": { "type": "string", "minLength": 1, "maxLength": 4096 }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "redirectUri", "expectedVersion" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/model_providers/{providerId}/oauth/authorizations/{authorizationId}/complete": { "post": { "tags": [ "Model providers" ], "operationId": "modelProviders.completeProviderAuthorization", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "authorizationId", "in": "path", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "callbackUrl": { "type": "string", "minLength": 1, "maxLength": 16384 } }, "required": [ "callbackUrl" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/model_providers/{providerId}/oauth": { "delete": { "tags": [ "Model providers" ], "operationId": "modelProviders.disconnectProviderOAuth", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } }, "required": [ "revoked" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/model_providers/{providerId}/available_models": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.getProviderAvailableModels", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "name", "reasoningEfforts", "serviceTiers" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/model_catalog": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.getModelCatalog", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" } }, "required": [ "id", "owner", "kind", "name" ], "additionalProperties": false } }, "models": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string" }, "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "price": { "type": "object", "properties": { "model": { "type": "string" }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 }, "effectiveFrom": { "type": "string" } }, "required": [ "model", "timeZone", "tiers", "periods", "effectiveFrom" ], "additionalProperties": false } }, "required": [ "provider", "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers" ], "additionalProperties": false } } }, "required": [ "providers", "models" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the models that the caller may use now, for each provider that offers them." } }, "/v1/organization/models": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.listModels", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the models of the organization. The models that the platform shares are not in the list." }, "post": { "tags": [ "Model providers" ], "operationId": "modelProviders.createModel", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a model to the organization. Link it to a provider to use it.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "id", "name", "reasoningEfforts", "serviceTiers" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/models/{modelId}": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.getModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Model providers" ], "operationId": "modelProviders.updateModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "type": { "type": "string", "enum": [ "language", "decision", "live" ] }, "name": { "type": "string" }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "type", "name", "reasoningEfforts", "serviceTiers", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Model providers" ], "operationId": "modelProviders.deleteModel", "parameters": [ { "name": "modelId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/model_providers": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.listModelProviders", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "Model providers" ], "operationId": "modelProviders.createModelProvider", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds a model provider. ChatGPT uses sign-in; other kinds need an API key.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "endpoint": { "type": "string", "minLength": 1 }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "kind", "name", "models" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/model_providers/{providerId}": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.getModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "Model providers" ], "operationId": "modelProviders.updateModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "type": "string", "enum": [ "platform", "organization" ] }, "kind": { "type": "string", "enum": [ "openai", "chatgpt", "anthropic", "openai-compat", "typesafe" ] }, "name": { "type": "string" }, "endpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "apiKey": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "oauth": { "type": "object", "properties": { "connected": { "type": "boolean" }, "loginRequired": { "type": "boolean" }, "email": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "connected", "loginRequired" ], "additionalProperties": false }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false } }, "availability": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "All" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "None" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Selected" ] }, "organizations": { "type": "array", "items": { "type": "string" }, "maxItems": 1000 } }, "required": [ "_tag", "organizations" ], "additionalProperties": false }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "owner", "kind", "name", "endpoint", "apiKey", "models", "availability", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Changes a model provider. The next model call uses the change.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "endpoint": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "apiKey": { "type": "string", "minLength": 1, "maxLength": 4096 }, "models": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "modelOwner": { "type": "string", "enum": [ "platform", "organization" ] }, "upstream": { "type": "string", "minLength": 1, "maxLength": 200 }, "reasoningEfforts": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "serviceTiers": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 50 }, "contextWindow": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, "maxOutputTokens": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, "required": [ "model", "modelOwner" ], "additionalProperties": false }, "maxItems": 200 } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "Model providers" ], "operationId": "modelProviders.deleteModelProvider", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/model_providers/{providerId}/prices": { "get": { "tags": [ "Model providers" ], "operationId": "modelProviders.listModelPrices", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string" }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 }, "effectiveFrom": { "type": "string" } }, "required": [ "model", "timeZone", "tiers", "periods", "effectiveFrom" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Lists the current price of each model of a provider of the organization. Usage of these models counts toward budgets, but never takes credits." }, "put": { "tags": [ "Model providers" ], "operationId": "modelProviders.setModelPrice", "parameters": [ { "name": "providerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string" }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 }, "effectiveFrom": { "type": "string" } }, "required": [ "model", "timeZone", "tiers", "periods", "effectiveFrom" ], "additionalProperties": false } } } }, "400": { "description": "ModelProviderAuthorizationInvalid | ModelProviderInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderAuthorizationInvalidEncoded" }, { "$ref": "#/components/schemas/ModelProviderInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "ModelProviderNotFound | ModelNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderNotFoundEncoded" }, { "$ref": "#/components/schemas/ModelNotFoundEncoded" } ] } } } }, "409": { "description": "ModelProviderLoginRequired | ModelProviderConflict | ModelProviderInUse | ModelConflict | ModelInUse | @nmnmcc/ability/Authorizer/Pending", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderLoginRequiredEncoded" }, { "$ref": "#/components/schemas/ModelProviderConflictEncoded" }, { "$ref": "#/components/schemas/ModelProviderInUseEncoded" }, { "$ref": "#/components/schemas/ModelConflictEncoded" }, { "$ref": "#/components/schemas/ModelInUseEncoded" }, { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "ModelProviderOAuthUnavailable | ModelProvidersUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModelProviderOAuthUnavailableEncoded" }, { "$ref": "#/components/schemas/ModelProvidersUnavailableEncoded" }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Sets a new price for one model of the provider. The price applies to calls from now on. Old calls keep their cost.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "string", "minLength": 1, "maxLength": 200 }, "timeZone": { "type": "string", "maxLength": 64 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 }, "periods": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 60 }, "windows": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" }, "days": { "type": "array", "items": { "type": "string", "enum": [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ] }, "minItems": 1, "maxItems": 7 } }, "required": [ "start", "end" ], "additionalProperties": false }, "minItems": 1, "maxItems": 20 }, "tiers": { "type": "array", "prefixItems": [ { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false } ], "minItems": 1, "items": { "type": "object", "properties": { "upToInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "inputUncached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheRead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inputCacheWrite": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "output": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outputReasoning": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "upToInputTokens", "inputUncached", "inputCacheRead", "inputCacheWrite", "output", "outputReasoning" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "name", "windows", "tiers" ], "additionalProperties": false }, "maxItems": 20 } }, "required": [ "model", "tiers" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/domains": { "get": { "tags": [ "SSO" ], "operationId": "sso.listDomains", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "recordName": { "type": "string" }, "recordValue": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "domain", "recordName", "recordValue", "verifiedAt", "createdAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "SSO" ], "operationId": "sso.addDomain", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "recordName": { "type": "string" }, "recordValue": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "domain", "recordName", "recordValue", "verifiedAt", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds an email domain. Then add the TXT record that the answer names, and call the verify endpoint.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" } }, "required": [ "domain" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/domains/{domain}/verify": { "post": { "tags": [ "SSO" ], "operationId": "sso.verifyDomain", "parameters": [ { "name": "domain", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string" }, "recordName": { "type": "string" }, "recordValue": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "string" } }, "required": [ "domain", "recordName", "recordValue", "verifiedAt", "createdAt" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Looks up the TXT record of the domain. When it is right, the domain becomes verified." } }, "/v1/organization/domains/{domain}": { "delete": { "tags": [ "SSO" ], "operationId": "sso.removeDomain", "parameters": [ { "name": "domain", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/v1/organization/sso_connections": { "get": { "tags": [ "SSO" ], "operationId": "sso.listSsoConnections", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "issuer": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "domains": { "type": "array", "items": { "type": "string" } }, "enforce": { "type": "boolean" }, "redirectUri": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "issuer", "clientId", "clientSecret", "domains", "enforce", "redirectUri", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "post": { "tags": [ "SSO" ], "operationId": "sso.createSsoConnection", "parameters": [], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "issuer": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "domains": { "type": "array", "items": { "type": "string" } }, "enforce": { "type": "boolean" }, "redirectUri": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "issuer", "clientId", "clientSecret", "domains", "enforce", "redirectUri", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "description": "Adds an OpenID Connect provider for people with an email in verified domains of the organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "issuer": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "type": "string", "minLength": 1, "maxLength": 4096 }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 50 }, "enforce": { "type": "boolean" } }, "required": [ "name", "issuer", "clientId", "domains", "enforce" ], "additionalProperties": false } } }, "required": true } } }, "/v1/organization/sso_connections/{connectionId}": { "get": { "tags": [ "SSO" ], "operationId": "sso.getSsoConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "issuer": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "domains": { "type": "array", "items": { "type": "string" } }, "enforce": { "type": "boolean" }, "redirectUri": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "issuer", "clientId", "clientSecret", "domains", "enforce", "redirectUri", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } }, "patch": { "tags": [ "SSO" ], "operationId": "sso.updateSsoConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "issuer": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "object", "properties": { "set": { "type": "boolean" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "set", "hint" ], "additionalProperties": false }, "domains": { "type": "array", "items": { "type": "string" } }, "enforce": { "type": "boolean" }, "redirectUri": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "issuer", "clientId", "clientSecret", "domains", "enforce", "redirectUri", "version", "createdAt", "updatedAt" ], "additionalProperties": false } } } }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "issuer": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "domains": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 50 }, "enforce": { "type": "boolean" } }, "required": [ "expectedVersion" ], "additionalProperties": false } } }, "required": true } }, "delete": { "tags": [ "SSO" ], "operationId": "sso.deleteSsoConnection", "parameters": [ { "name": "connectionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "token": [] }, { "session": [] } ], "responses": { "204": { "description": "" }, "400": { "description": "SsoConnectionInvalid | OrganizationRequired", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SsoConnectionInvalidEncoded" }, { "$ref": "#/components/schemas/OrganizationRequiredEncoded" } ] } } } }, "401": { "description": "AuthenticationRequired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationRequiredEncoded" } } } }, "403": { "description": "@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_ForbiddenEncoded" }, { "$ref": "#/components/schemas/MembershipRequiredEncoded" }, { "$ref": "#/components/schemas/ForbiddenOriginEncoded" } ] } } } }, "404": { "description": "DomainNotFound | SsoConnectionNotFound", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DomainNotFoundEncoded" }, { "$ref": "#/components/schemas/SsoConnectionNotFoundEncoded" } ] } } } }, "409": { "description": "@nmnmcc/ability/Authorizer/Pending | DomainTaken | DomainNotVerified | DomainInUse | SsoConnectionConflict", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/_nmnmcc_ability_Authorizer_PendingEncoded" }, { "$ref": "#/components/schemas/DomainTakenEncoded" }, { "$ref": "#/components/schemas/DomainNotVerifiedEncoded" }, { "$ref": "#/components/schemas/DomainInUseEncoded" }, { "$ref": "#/components/schemas/SsoConnectionConflictEncoded" } ] } } } }, "429": { "description": "RateLimited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RateLimitedEncoded" } } } }, "503": { "description": "SsoUnavailable | AuthenticationUnavailable | RequestFailed", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PolicyUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "$ref": "#/components/schemas/SsoUnavailableEncoded" }, { "$ref": "#/components/schemas/AuthenticationUnavailableEncoded" }, { "$ref": "#/components/schemas/RequestFailedEncoded" } ] } } } } } } }, "/": { "get": { "tags": [ "Service and health" ], "operationId": "health.getService", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "enum": [ "OpenBot API" ] }, "documentation": { "type": "string", "enum": [ "/docs" ] }, "openapi": { "type": "string", "enum": [ "/openapi.json" ] }, "auth": { "type": "string", "enum": [ "/auth" ] }, "tokens": { "type": "string", "enum": [ "/v1/user/tokens" ] } }, "required": [ "name", "documentation", "openapi", "auth", "tokens" ], "additionalProperties": false } } } }, "503": { "description": "RequestFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestFailedEncoded" } } } } }, "description": "Shows where to find the API reference, the Better Auth routes and the user token routes." } }, "/health": { "get": { "tags": [ "Service and health" ], "operationId": "health.getHealth", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ok" ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "503": { "description": "RequestFailed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestFailedEncoded" } } } } }, "description": "Checks that the HTTP service can respond. It does not check business dependencies." } } }, "components": { "schemas": { "RequestFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestFailed" ] }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] }, "errorId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "category", "errorId" ], "additionalProperties": false }, "RateLimitedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RateLimited" ] }, "retryAfterSeconds": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "_tag", "retryAfterSeconds" ], "additionalProperties": false }, "AuthenticationRequiredEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthenticationRequired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "OrganizationRequiredEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OrganizationRequired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "SsoConnectionInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SsoConnectionInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "SsoConnectionNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SsoConnectionNotFound" ] }, "connectionId": { "type": "string" } }, "required": [ "_tag", "connectionId" ], "additionalProperties": false }, "DomainNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DomainNotFound" ] }, "domain": { "type": "string" } }, "required": [ "_tag", "domain" ], "additionalProperties": false }, "SsoConnectionConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SsoConnectionConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "DomainInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DomainInUse" ] }, "domain": { "type": "string" } }, "required": [ "_tag", "domain" ], "additionalProperties": false }, "DomainNotVerifiedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DomainNotVerified" ] }, "domain": { "type": "string" } }, "required": [ "_tag", "domain" ], "additionalProperties": false }, "DomainTakenEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DomainTaken" ] }, "domain": { "type": "string" } }, "required": [ "_tag", "domain" ], "additionalProperties": false }, "_nmnmcc_ability_Authorizer_PendingEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Pending" ] }, "ticket": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "_tag", "ticket" ], "additionalProperties": false }, "AuthenticationUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AuthenticationUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "SsoUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SsoUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ForbiddenOriginEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ForbiddenOrigin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "MembershipRequiredEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "MembershipRequired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "_nmnmcc_ability_Authorizer_ForbiddenEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Forbidden" ] }, "action": { "type": "string" }, "kind": { "type": "string" }, "field": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "_tag", "action", "kind" ], "additionalProperties": false }, "ModelNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelNotFound" ] }, "modelId": { "type": "string" } }, "required": [ "_tag", "modelId" ], "additionalProperties": false }, "ModelProviderNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderNotFound" ] }, "providerId": { "type": "string" } }, "required": [ "_tag", "providerId" ], "additionalProperties": false }, "ModelProvidersUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProvidersUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ModelProviderOAuthUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderOAuthUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ModelProviderInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ModelProviderAuthorizationInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderAuthorizationInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ModelInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelInUse" ] }, "modelId": { "type": "string" } }, "required": [ "_tag", "modelId" ], "additionalProperties": false }, "ModelConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "ModelProviderInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderInUse" ] }, "providerId": { "type": "string" } }, "required": [ "_tag", "providerId" ], "additionalProperties": false }, "ModelProviderConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "ModelProviderLoginRequiredEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ModelProviderLoginRequired" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "OrganizationStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OrganizationStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "RoleNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RoleNotFound" ] }, "roleId": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "required": [ "_tag", "roleId" ], "additionalProperties": false }, "RoleReadOnlyEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RoleReadOnly" ] }, "roleId": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "required": [ "_tag", "roleId" ], "additionalProperties": false }, "RoleInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RoleInUse" ] }, "roleId": { "anyOf": [ { "type": "string", "enum": [ "super_administrator", "administrator", "administrator_read_only", "member", "auditor" ] }, { "type": "string" } ] } }, "required": [ "_tag", "roleId" ], "additionalProperties": false }, "SettingsInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SettingsInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "SettingsConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SettingsConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "SettingsUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SettingsUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "Config.SelectionEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Config.Selection" ] }, "provider": { "type": "string" }, "model": { "type": "string" }, "reasoningEffort": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "serviceTier": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "model" ], "additionalProperties": false }, "InvitationInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InvitationInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "InvitationNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "InvitationNotFound" ] }, "invitationId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag" ], "additionalProperties": false }, "MemberNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "MemberNotFound" ] }, "userId": { "type": "string" } }, "required": [ "_tag", "userId" ], "additionalProperties": false }, "LastSuperAdministratorEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "LastSuperAdministrator" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "TokenStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TokenStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "TokenNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TokenNotFound" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "TokenLimitReachedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TokenLimitReached" ] }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "_tag", "limit" ], "additionalProperties": false }, "PlatformUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PlatformUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "OrganizationNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OrganizationNotFound" ] }, "organizationId": { "type": "string" } }, "required": [ "_tag", "organizationId" ], "additionalProperties": false }, "LastPlatformAdminEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "LastPlatformAdmin" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "PlatformAdminNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PlatformAdminNotFound" ] }, "email": { "type": "string" } }, "required": [ "_tag", "email" ], "additionalProperties": false }, "OrganizationCreationDisabledEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "OrganizationCreationDisabled" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "SignInUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SignInUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "AppAuthorizationFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppAuthorizationFailed" ] }, "reason": { "type": "string" }, "message": { "type": "string" } }, "required": [ "_tag", "reason", "message" ], "additionalProperties": false }, "ConnectionConfigurationInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionConfigurationInvalid" ] }, "message": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "message", "keys" ], "additionalProperties": false }, "AppDiscoveryFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppDiscoveryFailed" ] }, "reason": { "type": "string", "enum": [ "InvalidInput", "IncompatibleCard", "NoDeclaration", "NoUsableServices", "Document", "Http", "BlockedTarget", "Transport", "TooLarge", "Timeout", "Redirect", "Encoding" ] }, "issues": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "reason": { "type": "string" }, "fieldPath": { "type": "string" } }, "required": [ "url", "reason" ], "additionalProperties": false } } }, "required": [ "_tag", "reason", "issues" ], "additionalProperties": false }, "ExecutionUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionUnavailable" ] }, "errorId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "errorId" ], "additionalProperties": false }, "ExperienceStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExperienceStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ExecutionNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionNotFound" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ExperienceNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExperienceNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ExperienceInputInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExperienceInputInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ExecutionForbiddenEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionForbidden" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "AppRestrictedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppRestricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false }, "ExecutionKeyConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionKeyConflict" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ExecutionConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ExecutionConflict" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ConnectionConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionConflict" ] }, "reason": { "type": "string", "enum": [ "CandidateChanged", "RevisionChanged", "DraftExpired", "AlreadyAdded", "LimitReached" ] }, "message": { "type": "string" } }, "required": [ "_tag", "reason", "message" ], "additionalProperties": false }, "ConnectionCleanupPendingEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectionCleanupPending" ] }, "connectionId": { "type": "string", "minLength": 1, "maxLength": 128 }, "stage": { "type": "string", "enum": [ "Credentials", "Connection" ] }, "message": { "type": "string" } }, "required": [ "_tag", "connectionId", "stage", "message" ], "additionalProperties": false }, "ChatConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChatConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "AppViewUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppViewUnavailable" ] }, "reason": { "type": "string", "enum": [ "Declaration", "Resource", "ConnectionChanged", "Closed", "Unsupported", "Protocol" ] }, "message": { "type": "string" } }, "required": [ "_tag", "reason", "message" ], "additionalProperties": false }, "ChatStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChatStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ChatNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChatNotFound" ] }, "chat": { "type": "string" } }, "required": [ "_tag", "chat" ], "additionalProperties": false }, "ChatModelInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChatModelInvalid" ] }, "reason": { "type": "string", "enum": [ "provider-not-found", "model-not-found", "unsupported-option", "missing" ] }, "message": { "type": "string" } }, "required": [ "_tag", "reason", "message" ], "additionalProperties": false }, "BudgetNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BudgetNotFound" ] }, "budgetId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "budgetId" ], "additionalProperties": false }, "BudgetInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BudgetInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "UsageQueryInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "UsageQueryInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "BudgetConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BudgetConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "BillingUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BillingUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "VaultInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "VaultInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "SecretProviderFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SecretProviderFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "SecretProviderNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SecretProviderNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "VaultItemNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "VaultItemNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "VaultNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "VaultNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "VaultConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "VaultConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "SecretProviderInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SecretProviderInUse" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "VaultsUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "VaultsUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ComputersUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputersUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ConnectorDeniedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ConnectorDenied" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "PairingInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "PairingInvalid" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ComputerExecutionFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerExecutionFailed" ] }, "failure": { "type": "object", "properties": { "errorId": { "type": "string", "minLength": 1, "maxLength": 128 }, "category": { "type": "string", "enum": [ "invalid", "forbidden", "not_found", "conflict", "unavailable", "external", "outcome_unknown", "interrupted" ] } }, "required": [ "errorId", "category" ], "additionalProperties": false } }, "required": [ "_tag", "failure" ], "additionalProperties": false }, "ComputerProviderFailedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerProviderFailed" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ComputerInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ComputerProviderNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerProviderNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ComputerSessionNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerSessionNotFound" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ComputerPathNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerPathNotFound" ] }, "path": { "type": "string" } }, "required": [ "_tag", "path" ], "additionalProperties": false }, "ComputerNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ComputerNotReadyEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerNotReady" ] }, "state": { "type": "string", "enum": [ "starting", "running", "paused", "offline", "failed" ] } }, "required": [ "_tag", "state" ], "additionalProperties": false }, "ComputerUnsupportedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerUnsupported" ] }, "feature": { "type": "string", "enum": [ "pause", "desktop", "ports", "stream" ] } }, "required": [ "_tag", "feature" ], "additionalProperties": false }, "ComputerConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "executionId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "ComputerProviderInUseEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ComputerProviderInUse" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ChannelsUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelsUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ChannelHookDeniedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelHookDenied" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ChannelIdentityNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelIdentityNotFound" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ChannelLinkInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelLinkInvalid" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "ChannelInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "ChannelConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelConflict" ] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "version" ], "additionalProperties": false }, "ChannelNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChannelNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "TriggerHookDeniedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TriggerHookDenied" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "TriggerStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TriggerStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "TriggerInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TriggerInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "TriggerNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TriggerNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "TriggerConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "TriggerConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "BotInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BotInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "RequestNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestNotFound" ] }, "request": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "request" ], "additionalProperties": false }, "BotNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BotNotFound" ] }, "bot": { "type": "string" } }, "required": [ "_tag", "bot" ], "additionalProperties": false }, "RequestConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RequestConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "BotConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BotConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "BotStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "BotStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "GrantNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "GrantNotFound" ] }, "grant": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "grant" ], "additionalProperties": false }, "RuleNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "RuleNotFound" ] }, "rule": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "rule" ], "additionalProperties": false }, "DelegationStorageUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DelegationStorageUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "DelegationConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DelegationConflict" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "DelegationNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DelegationNotFound" ] }, "delegation": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "delegation" ], "additionalProperties": false }, "FilesUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "FilesUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "FilesDisabledEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "FilesDisabled" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "FileQuotaExceededEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "FileQuotaExceeded" ] }, "message": { "type": "string" }, "quotaBytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "usedBytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "message", "quotaBytes", "usedBytes" ], "additionalProperties": false }, "FileInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "FileInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "FileNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "FileNotFound" ] }, "id": { "type": "string" } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "ChatExecutionUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ChatExecutionUnavailable" ] }, "chat": { "type": "string" } }, "required": [ "_tag", "chat" ], "additionalProperties": false }, "LiveUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "LiveUnavailable" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "effect_ai_AiResponse_UsageEncoded": { "type": "object", "properties": { "inputTokens": { "type": "object", "properties": { "uncached": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "total": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "cacheRead": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "cacheWrite": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": false }, "outputTokens": { "type": "object", "properties": { "total": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "reasoning": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": [ "inputTokens", "outputTokens" ], "additionalProperties": false }, "ToolCallNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "ToolCallNotFound" ] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "_tag", "id" ], "additionalProperties": false }, "PromptEncoded": {}, "Config.ModelEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Config.Model" ] }, "provider": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "list", "hide", "none" ] }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "defaultReasoningLevel": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "reasoningLevels": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "effort": { "type": "string", "minLength": 1 }, "description": { "type": "string" } }, "required": [ "effort", "description" ], "additionalProperties": false } }, { "type": "null" } ] }, "defaultServiceTier": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "serviceTierOptions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false } }, { "type": "null" } ] }, "maxContextWindow": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "effectiveContextWindowPercent": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "effectiveContextWindow": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "instructionsTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "supportVerbosity": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "defaultVerbosity": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ] }, { "type": "null" } ] }, "supportsReasoningSummaryParameter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "defaultReasoningSummary": { "anyOf": [ { "type": "string", "enum": [ "auto", "concise", "detailed", "none" ] }, { "type": "null" } ] }, "reasoningEfforts": { "type": "array", "items": { "type": "string" } }, "serviceTiers": { "type": "array", "items": { "type": "string" } }, "maxInputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "maxOutputTokensLimit": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "topP": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tokenCounting": { "anyOf": [ { "type": "string", "enum": [ "native", "estimate" ] }, { "type": "null" } ] }, "contextWindow": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] }, "compaction": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "Native" ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "NonNative" ] }, "model": { "anyOf": [ { "$ref": "#/components/schemas/Config.SelectionEncoded" }, { "type": "null" } ] }, "keepRecentMessages": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] } }, "required": [ "_tag" ], "additionalProperties": false }, { "type": "null" } ] }, "autoCompactTokenLimit": { "anyOf": [ { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 }, { "type": "null" } ] } }, "required": [ "_tag", "provider", "id", "name", "reasoningEfforts", "serviceTiers" ], "additionalProperties": false }, "AppAuthorizationUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "AppAuthorizationUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "IndexUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "IndexUnavailable" ] }, "issues": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1 }, "message": { "type": "string" } }, "required": [ "source", "message" ], "additionalProperties": false } } }, "required": [ "_tag", "issues" ], "additionalProperties": false }, "IndexNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "IndexNotFound" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "IndexInputInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "IndexInputInvalid" ] }, "message": { "type": "string" } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "IndexRestrictedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "IndexRestricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false }, "DeveloperInputInvalidEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperInputInvalid" ] }, "message": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "_tag", "message" ], "additionalProperties": false }, "DeveloperUnavailableEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperUnavailable" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "DeveloperForbiddenEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperForbidden" ] } }, "required": [ "_tag" ], "additionalProperties": false }, "DeveloperRestrictedEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperRestricted" ] }, "restriction": { "type": "object", "properties": { "cardUrl": { "type": "string" }, "reason": { "type": "string", "minLength": 1 }, "appealUrl": { "type": "string" } }, "required": [ "cardUrl", "reason", "appealUrl" ], "additionalProperties": false } }, "required": [ "_tag", "restriction" ], "additionalProperties": false }, "DeveloperConflictEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperConflict" ] }, "reason": { "type": "string" } }, "required": [ "_tag", "reason" ], "additionalProperties": false }, "DeveloperNotFoundEncoded": { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "DeveloperNotFound" ] } }, "required": [ "_tag" ], "additionalProperties": false } }, "securitySchemes": { "token": { "type": "http", "scheme": "Bearer" }, "session": { "type": "apiKey", "name": "__Host-openbot-session", "in": "cookie" } } }, "security": [], "tags": [ { "name": "Account", "description": "Read the signed-in user and their organizations." }, { "name": "Sign-in", "description": "Start a browser sign-in." }, { "name": "Organizations", "description": "List your organizations and make a new one." }, { "name": "User tokens", "description": "Make, list, check, and revoke user tokens." }, { "name": "Organization", "description": "Manage settings, members, roles, policies, and the audit log." }, { "name": "Model providers", "description": "Add providers with API keys or ChatGPT sign-in, and list the models you can use." }, { "name": "SSO", "description": "Verify email domains and add SSO connections." }, { "name": "Usage", "description": "Read the model usage, its cost, and the credits of the organization." }, { "name": "Budgets", "description": "Set spending limits for the organization, members, Bots, and user tokens." }, { "name": "Platform", "description": "Manage the whole platform. Only platform admins can use it." }, { "name": "Bots", "description": "Make, manage, and share Bots, with their memory, Rules, Grants, members, and invitations." }, { "name": "Chats", "description": "Talk to a Bot. Each Bot has one Chat with each person, and the Bot always answers at once." }, { "name": "Executions", "description": "Read saved execution events, send a cancel command, and answer a decision." }, { "name": "Live", "description": "Talk with a Bot in real time, with sound, over one WebSocket." }, { "name": "Files", "description": "Upload files, such as pictures and PDFs, and give them to a Bot in a message." }, { "name": "Delegations", "description": "Read or stop the work that a Bot gave to another Bot or to itself." }, { "name": "Bot invitations", "description": "Accept an invitation to use a Bot in your own organization." }, { "name": "Triggers", "description": "Give a task to a Bot with a prompt, on a schedule or from a webhook." }, { "name": "Trigger webhooks", "description": "Fire a trigger from another system with its webhook secret." }, { "name": "Channels", "description": "Manage the bots of the organization in Slack, Lark, Telegram and other chat systems." }, { "name": "Channel links", "description": "Link your own accounts on the platforms of Channels." }, { "name": "Channel webhooks", "description": "Take the events of chat platforms. The signature of the platform is the only credential." }, { "name": "Computer providers", "description": "Add your accounts at services that run Computers, such as E2B and Daytona." }, { "name": "Computers", "description": "Make and use machines where Bots run commands, change files and use a desktop." }, { "name": "Computer connectors", "description": "Pair your own machine and keep it connected. The token is the only credential." }, { "name": "Secret providers", "description": "Add your accounts at password managers and secrets services, such as 1Password, Bitwarden and HashiCorp Vault." }, { "name": "Vaults", "description": "Collect secrets from many providers, and let Bots use them in Code Mode without seeing them." }, { "name": "Your settings", "description": "Read and change your own settings, such as how your plans are approved." }, { "name": "Requests", "description": "Answer the requests of your Bots for new capabilities." }, { "name": "App discovery", "description": "Find Apps that the Bot can use." }, { "name": "Connections", "description": "Connect an account to an App." }, { "name": "App authorization", "description": "Let an App act for you." }, { "name": "App authorization callbacks", "description": "Pages that an App sends you back to after authorization." }, { "name": "Tool calls", "description": "Read the tool calls of a Chat and their saved results." }, { "name": "App operations", "description": "Run App operations and read their results." }, { "name": "Code runs", "description": "Read the Code Mode programs of a Chat and their App calls." }, { "name": "App views", "description": "Read the views that Apps show." }, { "name": "App transfer and reset", "description": "Export, import, and reset what the Bot learned about Apps." }, { "name": "App Index", "description": "Search the public index of Apps." }, { "name": "Developer tools", "description": "Test and watch the Apps that you publish." }, { "name": "Public developer tools", "description": "Developer tools that work without sign-in." }, { "name": "Service and health", "description": "Read the service document and check health." } ] }