{ "openapi": "3.1.0", "info": { "title": "Kontext API", "version": "1.0.0", "description": "API documentation for Kontext — generated from Zod schemas in @kontext/api-contract" }, "servers": [ { "url": "https://getkontext.io/api", "description": "Production" }, { "url": "http://localhost:5173/api", "description": "Development" } ], "security": [ { "BearerAuth": [] } ], "components": { "schemas": {}, "parameters": {}, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key (ktx_key_*) or session Bearer token" } } }, "paths": { "/v1/feedback": { "post": { "summary": "Submit feedback", "tags": [ "Feedback" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": "string", "minLength": 1 }, "content": { "type": "object", "properties": { "title": { "type": "string" }, "body": { "type": "string", "minLength": 1 }, "bodyFormat": { "type": "string", "enum": [ "text", "json", "html", "markdown" ], "default": "markdown" } }, "required": [ "body" ] }, "sourceUrl": { "type": "string", "format": "uri" }, "feedbackType": { "type": "string", "enum": [ "bug", "feature_request", "support_ticket", "prospect_call", "support_call", "research_call", "generic_feedback" ], "default": "generic_feedback" }, "contextId": { "type": "string" }, "actorId": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {}, "default": {} }, "notes": { "type": "string" }, "source": { "anyOf": [ { "type": "string", "enum": [ "manual", "api" ] }, { "type": "string" } ] } }, "required": [ "productId", "content" ] } } } }, "responses": { "201": { "description": "Feedback submitted and queued for processing", "content": { "application/json": { "schema": { "type": "object", "properties": { "feedbackId": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "status": { "type": "string", "enum": [ "queued" ] } }, "required": [ "feedbackId", "url", "status" ] } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/feedback/{feedbackId}/status": { "get": { "summary": "Get feedback processing status", "tags": [ "Feedback" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "feedbackId", "in": "path" } ], "responses": { "200": { "description": "Current processing status", "content": { "application/json": { "schema": { "type": "object", "properties": { "feedbackId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "processing", "completed", "failed" ] }, "resultUrl": { "type": "string", "format": "uri" } }, "required": [ "feedbackId", "status" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "422": { "description": "Unprocessable entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/contexts": { "get": { "summary": "List contexts for a product", "tags": [ "Contexts" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "List of contexts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "description" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/actors": { "get": { "summary": "List actors for a product", "tags": [ "Actors" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "List of actors", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "description" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products": { "get": { "summary": "List products", "tags": [ "Products" ], "responses": { "200": { "description": "List of products for the organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}": { "get": { "summary": "Get a product", "tags": [ "Products" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "Product details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "createdAt", "updatedAt" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/problems": { "get": { "summary": "List problems for a product", "tags": [ "Problems" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "List of problems", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "statement": { "type": [ "string", "null" ] }, "statementFormat": { "type": "string", "enum": [ "text", "json", "html", "markdown" ] }, "status": { "type": "string", "enum": [ "unreviewed", "draft", "published", "archived" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "statement", "statementFormat", "status", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/problems/{problemId}": { "get": { "summary": "Get a problem", "tags": [ "Problems" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" }, { "schema": { "type": "string" }, "required": true, "name": "problemId", "in": "path" } ], "responses": { "200": { "description": "Problem details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "statement": { "type": [ "string", "null" ] }, "statementFormat": { "type": "string", "enum": [ "text", "json", "html", "markdown" ] }, "status": { "type": "string", "enum": [ "unreviewed", "draft", "published", "archived" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "statement", "statementFormat", "status", "createdAt", "updatedAt" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/features": { "get": { "summary": "List features for a product", "tags": [ "Features" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "List of features", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "descriptionFormat": { "type": "string", "enum": [ "text", "json", "html", "markdown" ] }, "status": { "type": "string", "enum": [ "unreviewed", "draft", "published", "archived" ] }, "parentId": { "type": [ "string", "null" ] }, "releaseId": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "description", "descriptionFormat", "status", "parentId", "releaseId", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/products/{productId}/releases": { "get": { "summary": "List releases for a product", "tags": [ "Releases" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "productId", "in": "path" } ], "responses": { "200": { "description": "List of releases", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "notes": { "type": [ "string", "null" ] }, "releaseDate": { "type": "string", "format": "date-time" }, "isProd": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "unreviewed", "draft", "published", "archived" ] }, "sourceUrl": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "slug", "name", "notes", "releaseDate", "isProd", "tags", "status", "sourceUrl", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/organizations": { "get": { "summary": "List organizations", "tags": [ "Organizations" ], "responses": { "200": { "description": "List of organizations the authenticated user belongs to", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "avatarType": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "slug", "avatarType", "createdAt", "updatedAt" ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } }, "post": { "summary": "Create an organization", "tags": [ "Organizations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 } }, "required": [ "name", "slug" ] } } } }, "responses": { "201": { "description": "Created organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "avatarType": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "slug", "avatarType", "createdAt", "updatedAt" ] } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/organizations/{orgId}": { "get": { "summary": "Get an organization", "tags": [ "Organizations" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "orgId", "in": "path" } ], "responses": { "200": { "description": "Organization details", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "avatarType": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "slug", "avatarType", "createdAt", "updatedAt" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/organizations/{orgId}/members": { "get": { "summary": "List organization members", "tags": [ "Organizations" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "orgId", "in": "path" } ], "responses": { "200": { "description": "List of organization members", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "joinedAt": { "type": "string", "format": "date-time" } }, "required": [ "userId", "firstName", "lastName", "email", "role", "joinedAt" ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/organizations/{orgId}/invite": { "post": { "summary": "Invite a member to an organization", "tags": [ "Organizations" ], "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "orgId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "role": { "type": "string", "enum": [ "admin", "member" ] } }, "required": [ "email", "role" ] } } } }, "responses": { "200": { "description": "Invitation sent" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/me": { "get": { "summary": "Get authenticated user", "tags": [ "Users" ], "responses": { "200": { "description": "Authenticated user profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "emailVerified": { "type": "boolean" }, "preferences": { "type": "object", "additionalProperties": {} }, "avatarType": { "type": [ "string", "null" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "firstName", "lastName", "email", "emailVerified", "preferences", "avatarType", "createdAt", "updatedAt" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } }, "put": { "summary": "Update authenticated user", "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "avatarBase64": { "type": "string" }, "avatarType": { "type": "string" }, "preferences": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] } } } } } } } }, "responses": { "200": { "description": "User updated" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } }, "/v1/installations/me": { "get": { "summary": "Get the installation associated with the API key", "tags": [ "Installations" ], "responses": { "200": { "description": "Installation details for the current API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "integrationId": { "type": "string" }, "orgId": { "type": "string" }, "config": { "type": [ "object", "null" ], "additionalProperties": {} }, "status": { "type": "string", "enum": [ "pending", "active", "inactive", "failing" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "integrationId", "orgId", "config", "status", "createdAt" ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": [ "code", "message" ] } } }, "required": [ "error" ] } } } } } } } }, "webhooks": {} }