{ "openapi": "3.1.0", "info": { "title": "Clanker Test Public API", "version": "1.0.0", "description": "HTTP API for every Clanker Test web action. Create a hashed API key on the website (Security settings), then send `Authorization: Bearer ctk_…` or `X-API-Key`. The web app does not call this API; it uses the same Effect services directly. MCP and `/agent/v1` use agent OAuth access tokens, not API keys." }, "paths": { "/health": { "get": { "tags": ["system"], "operationId": "system.health", "parameters": [], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "service"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "service": { "type": "string", "enum": ["api"] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Liveness" } }, "/v1/api-keys": { "get": { "tags": ["apiKeys"], "operationId": "apiKeys.list", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "tokenPrefix", "lastFour", "createdAt", "lastUsedAt" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "tokenPrefix": { "type": "string" }, "lastFour": { "type": "string" }, "createdAt": { "type": "string" }, "lastUsedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List API keys" }, "post": { "tags": ["apiKeys"], "operationId": "apiKeys.create", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["id", "name", "tokenPrefix", "lastFour", "secret"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "tokenPrefix": { "type": "string" }, "lastFour": { "type": "string" }, "secret": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create API key", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/api-keys/{apiKeyId}/revoke": { "post": { "tags": ["apiKeys"], "operationId": "apiKeys.revoke", "parameters": [ { "name": "apiKeyId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Revoke API key" } }, "/v1/me": { "get": { "tags": ["me"], "operationId": "me.profile", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["id", "name", "email", "image"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get profile" }, "patch": { "tags": ["me"], "operationId": "me.updateProfile", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update profile name", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/me/photo": { "post": { "tags": ["me"], "operationId": "me.uploadPhoto", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "image"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "image": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Upload profile photo", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object" } } } } } }, "/v1/me/preferences": { "get": { "tags": ["me"], "operationId": "me.preferences", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["userId", "productUpdates", "workspaceActivity"], "properties": { "userId": { "type": "string" }, "productUpdates": { "type": "boolean" }, "workspaceActivity": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get notification preferences" }, "patch": { "tags": ["me"], "operationId": "me.updatePreferences", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update notification preferences", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["productUpdates", "workspaceActivity"], "properties": { "productUpdates": { "type": "boolean" }, "workspaceActivity": { "type": "boolean" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/me/home": { "get": { "tags": ["me"], "operationId": "me.home", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "a string", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Home destination path" } }, "/v1/me/onboarding": { "get": { "tags": ["me"], "operationId": "me.onboarding", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["existing"], "properties": { "existing": { "anyOf": [ { "type": "object", "required": ["id", "name", "slug", "iconUrl", "role"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Onboarding workspace" } }, "/v1/workspaces": { "get": { "tags": ["workspaces"], "operationId": "workspaces.list", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "required": ["id", "name", "slug", "iconUrl", "role"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "type": "string" } }, "additionalProperties": false } } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List memberships" }, "post": { "tags": ["workspaces"], "operationId": "workspaces.create", "parameters": [], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "workspace"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "workspace": { "type": "object", "required": ["id", "name", "slug", "creatorUserId"], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "creatorUserId": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create workspace", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name", "slug"], "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/slugs/{slug}": { "get": { "tags": ["workspaces"], "operationId": "workspaces.slugAvailable", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "excludeWorkspaceId", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["available"], "properties": { "available": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Check whether a workspace slug is available" } }, "/v1/workspaces/{slug}": { "get": { "tags": ["workspaces"], "operationId": "workspaces.get", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "workspaceId", "name", "slug", "iconUrl", "allowedDomains", "role" ], "properties": { "userId": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "iconUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "allowedDomains": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get workspace" }, "patch": { "tags": ["workspaces"], "operationId": "workspaces.update", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update workspace", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name", "slug"], "properties": { "name": { "type": "string" }, "slug": { "type": "string" }, "allowedDomains": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/slug-availability": { "get": { "tags": ["workspaces"], "operationId": "workspaces.slugAvailability", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "slug", "in": "query", "schema": { "type": "string" }, "required": false } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["available"], "properties": { "available": { "type": "boolean" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Check a candidate slug against this workspace" } }, "/v1/workspaces/{slug}/icon": { "post": { "tags": ["workspaces"], "operationId": "workspaces.uploadIcon", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "iconUrl"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "iconUrl": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Upload workspace icon", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object" } } } } } }, "/v1/workspaces/{slug}/members": { "get": { "tags": ["workspaces"], "operationId": "workspaces.members", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List members" } }, "/v1/workspaces/{slug}/members/{userId}": { "patch": { "tags": ["workspaces"], "operationId": "workspaces.changeMemberRole", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Change member role", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["role"], "properties": { "role": { "type": "string", "enum": ["owner", "admin", "member", "viewer"] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": ["workspaces"], "operationId": "workspaces.removeMember", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Remove member" } }, "/v1/workspaces/{slug}/invites": { "get": { "tags": ["workspaces"], "operationId": "workspaces.invites", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List invites" }, "post": { "tags": ["workspaces"], "operationId": "workspaces.createInvites", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create invites", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["emails", "role", "teamIds"], "properties": { "emails": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": ["owner", "admin", "member", "viewer"] }, "teamIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/invites/{inviteId}/revoke": { "post": { "tags": ["workspaces"], "operationId": "workspaces.revokeInvite", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "inviteId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Revoke invite" } }, "/v1/workspaces/{slug}/invites/{inviteId}": { "patch": { "tags": ["workspaces"], "operationId": "workspaces.changeInviteRole", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "inviteId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Change invite role", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["role"], "properties": { "role": { "type": "string", "enum": ["owner", "admin", "member", "viewer"] } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/invites/{inviteId}/resend": { "post": { "tags": ["workspaces"], "operationId": "workspaces.resendInvite", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "inviteId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Resend invite" } }, "/v1/workspaces/{slug}/teams": { "get": { "tags": ["workspaces"], "operationId": "workspaces.teams", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List teams" }, "post": { "tags": ["workspaces"], "operationId": "workspaces.createTeam", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create team", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/teams/{teamId}": { "patch": { "tags": ["workspaces"], "operationId": "workspaces.renameTeam", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Rename team", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": ["workspaces"], "operationId": "workspaces.deleteTeam", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Delete team" } }, "/v1/workspaces/{slug}/teams/{teamId}/members": { "put": { "tags": ["workspaces"], "operationId": "workspaces.setTeamMembers", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Set team members", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["userIds"], "properties": { "userIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/products": { "get": { "tags": ["workspaces"], "operationId": "workspaces.products", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List products" }, "post": { "tags": ["workspaces"], "operationId": "workspaces.createProduct", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create product", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name", "type"], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": ["website", "api", "cli", "mobile_app", "desktop_app", "agent"] } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/products/{productId}": { "patch": { "tags": ["workspaces"], "operationId": "workspaces.updateProduct", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update product", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name", "type"], "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": ["website", "api", "cli", "mobile_app", "desktop_app", "agent"] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": ["workspaces"], "operationId": "workspaces.deleteProduct", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Delete product" } }, "/v1/workspaces/{slug}/products/{productId}/environments/{environmentId}": { "put": { "tags": ["workspaces"], "operationId": "workspaces.setProductEnvironment", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "environmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Set product environment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "baseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deployedVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": ["workspaces"], "operationId": "workspaces.removeProductEnvironment", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "environmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Remove product environment" } }, "/v1/workspaces/{slug}/environments": { "get": { "tags": ["workspaces"], "operationId": "workspaces.environments", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List environments" }, "post": { "tags": ["workspaces"], "operationId": "workspaces.createEnvironment", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Create environment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" }, "purpose": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emoji": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } } }, "/v1/workspaces/{slug}/environments/{environmentId}": { "patch": { "tags": ["workspaces"], "operationId": "workspaces.updateEnvironment", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "environmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Update environment", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": ["name"], "properties": { "name": { "type": "string" }, "purpose": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emoji": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "required": true } }, "delete": { "tags": ["workspaces"], "operationId": "workspaces.deleteEnvironment", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "environmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok"], "properties": { "ok": { "type": "boolean", "enum": [true] } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Delete environment" } }, "/v1/workspaces/{slug}/events": { "get": { "tags": ["workspaces"], "operationId": "workspaces.events", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "List events" } }, "/v1/workspaces/{slug}/people": { "get": { "tags": ["workspaces"], "operationId": "workspaces.people", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "People page data" } }, "/v1/workspaces/{slug}/seeds": { "get": { "tags": ["workspaces"], "operationId": "workspaces.seeds", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Seed workspaces" } }, "/v1/seeds/{workspaceId}/join": { "post": { "tags": ["workspaces"], "operationId": "workspaces.joinSeed", "parameters": [ { "name": "workspaceId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "slug"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "slug": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Join seed workspace" } }, "/v1/workspaces/{slug}/integrations": { "get": { "tags": ["workspaces"], "operationId": "workspaces.integrations", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Agent authorizations" } }, "/v1/workspaces/{slug}/integrations/{authorizationId}/revoke": { "post": { "tags": ["workspaces"], "operationId": "workspaces.revokeIntegration", "parameters": [ { "name": "slug", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "authorizationId", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Revoke agent authorization" } }, "/v1/invites/{token}/accept": { "post": { "tags": ["workspaces"], "operationId": "workspaces.acceptInvite", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [ { "apiKey": [] }, { "bearer": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "required": ["ok", "workspaceSlug"], "properties": { "ok": { "type": "boolean", "enum": [true] }, "workspaceSlug": { "type": "string" } }, "additionalProperties": false } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Accept invite" } }, "/v1/invites/{token}": { "get": { "tags": ["invites"], "operationId": "invites.inviteByToken", "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$id": "/schemas/unknown", "title": "unknown" } } } }, "400": { "description": "The request did not match the expected schema", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpApiDecodeError" }, { "$ref": "#/components/schemas/InvalidInput" } ] } } } }, "401": { "description": "API key required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } } }, "403": { "description": "Not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Forbidden" } } } }, "404": { "description": "Missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Internal" } } } } }, "summary": "Get invite by token" } } }, "components": { "schemas": { "HttpApiDecodeError": { "type": "object", "required": ["issues", "message", "_tag"], "properties": { "issues": { "type": "array", "items": { "$ref": "#/components/schemas/Issue" } }, "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["HttpApiDecodeError"] } }, "additionalProperties": false, "description": "The request did not match the expected schema" }, "Issue": { "type": "object", "required": ["_tag", "path", "message"], "properties": { "_tag": { "type": "string", "enum": [ "Pointer", "Unexpected", "Missing", "Composite", "Refinement", "Transformation", "Type", "Forbidden" ], "description": "The tag identifying the type of parse issue" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyKey" }, "description": "The path to the property where the issue occurred" }, "message": { "type": "string", "description": "A descriptive message explaining the issue" } }, "additionalProperties": false, "description": "Represents an error encountered while parsing a value to match the schema" }, "PropertyKey": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "required": ["_tag", "key"], "properties": { "_tag": { "type": "string", "enum": ["symbol"] }, "key": { "type": "string" } }, "additionalProperties": false, "description": "an object to be decoded into a globally shared symbol" } ] }, "InvalidInput": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["InvalidInput"] } }, "additionalProperties": false, "description": "Invalid request" }, "Unauthorized": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["Unauthorized"] } }, "additionalProperties": false, "description": "API key required" }, "Forbidden": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["Forbidden"] } }, "additionalProperties": false, "description": "Not allowed" }, "NotFound": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["NotFound"] } }, "additionalProperties": false, "description": "Missing" }, "Conflict": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["Conflict"] } }, "additionalProperties": false, "description": "Conflict" }, "Internal": { "type": "object", "required": ["message", "_tag"], "properties": { "message": { "type": "string" }, "_tag": { "type": "string", "enum": ["Internal"] } }, "additionalProperties": false, "description": "Server error" } }, "securitySchemes": { "apiKey": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "bearer": { "type": "http", "scheme": "bearer" } } }, "security": [], "tags": [ { "name": "system" }, { "name": "apiKeys" }, { "name": "me" }, { "name": "workspaces" }, { "name": "invites" } ], "servers": [ { "url": "https://api.clankertest.com", "description": "Production" }, { "url": "https://api.qa.clankertest.net", "description": "QA" }, { "url": "http://127.0.0.1:3200", "description": "Localhost" } ] }