{ "openapi": "3.1.0", "info": { "title": "SuperLinkin REST API", "version": "1.0.0", "description": "Access your connected browser’s cached LinkedIn conversations and SuperLinkin organization data. Chrome must be running. No sending, scraping, webhooks or unattended cloud sync. Use personal tokens only from your backend. Tokens cover all listed actions for one account; API and MCP share the same grant." }, "servers": [ { "url": "https://superlinkin.com/api/v1" } ], "security": [ { "personalToken": [] } ], "components": { "securitySchemes": { "personalToken": { "type": "http", "scheme": "bearer", "bearerFormat": "sl_mcp_<64 hex characters>", "description": "Create in Integrations → AI assistants & API. Replacement or Disconnect all revokes existing API and assistant access." } } }, "paths": { "/connection": { "get": { "operationId": "get_connection_status", "summary": "get connection status", "description": "Check browser connectivity and account access. Returns connected:false when the browser is offline. Available even after trial expiry.", "parameters": [], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations": { "get": { "operationId": "list_conversations", "summary": "list conversations", "description": "List cached conversations, newest first. Follow nextBefore and nextBeforeId, including on empty filtered pages.", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "all", "unread", "needs_reply" ], "default": "all" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "inbox", "archived", "snoozed", "done", "any" ], "default": "inbox" } }, { "name": "sinceDays", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 365 } }, { "name": "labelId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 100 } }, { "name": "starred", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum returned items. Defaults to 20 (30 when reading a conversation)." } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Cursor timestamp in milliseconds. Use with beforeId." } }, { "name": "beforeId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Cursor ID returned with the timestamp." } } ], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/search": { "get": { "operationId": "search_conversations", "summary": "search conversations", "description": "Search participant names, headlines and latest message previews. Follow nextBefore and nextBeforeId.", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 200 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum returned items. Defaults to 20 (30 when reading a conversation)." } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Cursor timestamp in milliseconds. Use with beforeId." } }, { "name": "beforeId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Cursor ID returned with the timestamp." } } ], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/messages/search": { "get": { "operationId": "search_messages", "summary": "search messages", "description": "Search cached message text and sender names. Every query word must match, ignoring case. Follow nextBefore and nextBeforeId.", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string", "minLength": 2, "maxLength": 200 } }, { "name": "conversationId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum returned items. Defaults to 20 (30 when reading a conversation)." } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Cursor timestamp in milliseconds. Use with beforeId." } }, { "name": "beforeId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Cursor ID returned with the timestamp." } } ], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/labels": { "get": { "operationId": "list_labels", "summary": "list labels", "description": "List existing SuperLinkin labels. Follow nextOffset as offset until null.", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum returned items. Defaults to 20 (30 when reading a conversation)." } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/{conversationId}": { "get": { "operationId": "read_conversation", "summary": "read conversation", "description": "Read cached text, draft, notes, labels and star. When hasOlderMessages is true, pass oldestSentAt and oldestMessageId as before and beforeId. Does not mark read on LinkedIn.", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "description": "Maximum returned items. Defaults to 20 (30 when reading a conversation)." } }, { "name": "before", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Cursor timestamp in milliseconds. Use with beforeId." } }, { "name": "beforeId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 500, "description": "Cursor ID returned with the timestamp." } } ], "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/{conversationId}/draft": { "put": { "operationId": "save_draft", "summary": "save draft", "description": "Create or replace a reply draft after reading its current revision. Previous text is not retained. A timeout may occur after a successful save; read again before retrying. Sending is manual.", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 8000, "description": "Reply draft text. Whitespace-only text is rejected. Never sends a message." }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "Current draft revision, or 0 when no draft exists. A stale revision returns 409." } }, "required": [ "body", "expectedRevision" ] } } } }, "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/{conversationId}/labels": { "patch": { "operationId": "update_conversation_labels", "summary": "update conversation labels", "description": "Add or remove existing labels while preserving other labels. A label cannot appear in both arrays. Does not change LinkedIn.", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "addLabelIds": { "type": "array", "maxItems": 20, "items": { "type": "string", "minLength": 1, "maxLength": 100 } }, "removeLabelIds": { "type": "array", "maxItems": 20, "items": { "type": "string", "minLength": 1, "maxLength": 100 } } } } } } }, "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/{conversationId}/star": { "put": { "operationId": "set_conversation_star", "summary": "set conversation star", "description": "Set the local SuperLinkin star. Repeating the same value is safe. Does not change LinkedIn.", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "starred": { "type": "boolean" } }, "required": [ "starred" ] } } } }, "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } }, "/conversations/{conversationId}/notes": { "post": { "operationId": "append_conversation_note", "summary": "append conversation note", "description": "Append a private note, preserving existing text. Read notesRevision first and reuse idempotencyKey for immediate retries. Does not send anything to LinkedIn or a CRM.", "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Opaque ID returned by the API. URL-encode it when used in a path." } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Text to append to private notes. Whitespace-only text is rejected." }, "expectedNotesRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "notesRevision from the latest conversation read." }, "idempotencyKey": { "type": "string", "pattern": "^[A-Za-z0-9_-]{8,100}$", "description": "Reuse the same key and text on retry. Only the last eight note receipts per conversation are retained." } }, "required": [ "text", "expectedNotesRevision", "idempotencyKey" ] } } } }, "responses": { "200": { "description": "Successful operation. Data fields and pagination are described in the developer guide.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "requestId" ], "properties": { "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "400": { "description": "Invalid request or unavailable conversation", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "401": { "description": "Invalid or revoked personal token", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "402": { "description": "Active trial or subscription required", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "403": { "description": "Untrusted browser origin", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "404": { "description": "Unknown endpoint", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "405": { "description": "Wrong HTTP method", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "409": { "description": "Draft or note revision conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "413": { "description": "Body exceeds 32 KiB", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "415": { "description": "Use application/json", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "429": { "description": "Rate or concurrency limit; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "502": { "description": "Relay unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "503": { "description": "Browser offline or reconnecting; respect Retry-After", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } }, "504": { "description": "Timed out; writes may have completed", "content": { "application/json": { "schema": { "type": "object", "required": [ "error", "requestId" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } } } } } }, "requestId": { "type": "string", "format": "uuid" } } } } } } } } } } }