{ "openapi": "3.0.3", "info": { "title": "Parkes API", "version": "1.0.0", "description": "The Parkes REST API manages resources in the organization selected during authorization.\n\n## Authentication and organization access\n\nSend an OAuth access token or personal token as `Authorization: Bearer `. Each credential belongs to exactly one organization. Authorize additional organizations separately; resource routes do not take an organization selection header or path parameter. Required scopes and current member permissions both apply. Use `GET /rest/v1/me` to inspect the authenticated identity.\n\n## Pagination\n\nCollections return `data` and `page.next_cursor`. A null cursor means the traversal is complete. Pass the cursor with the same filters to retrieve the next page. Most collections default to 50 records and allow up to 200; Knowledge search has its own limit. Activity tail cursors represent a continuing feed rather than a completed traversal.\n\n## Mutations and concurrency\n\nSend JSON for operations with a request body. Unknown fields are rejected; omitted update fields stay unchanged and null is accepted only where declared nullable. Every POST requires an `Idempotency-Key` of at most 128 bytes. Reuse the same key and body when retrying the same logical mutation. Other mutations accept an optional key.\n\nConditional mutations require `If-Match` with the resource's latest ETag. For nested automation triggers and Marketplace items, use the parent automation or release ETag returned by the read operation. Knowledge content writes additionally require `expected_version` from the document's version field. A 202 response confirms admission, not completion; follow the returned operation or run.\n\n## Errors and limits\n\nHandled API errors use `application/problem+json`. Inspect `code` for the error category, `detail` for context, and `request_id` when reporting a failure. Validation errors may include an `errors` object keyed by field. Each operation lists its expected errors. Unexpected server or infrastructure errors may have a different body; clients must tolerate other HTTP error responses.\n\nThe request body limit is 2 MiB unless an operation specifies otherwise. The limit applies even to a body sent with a read request. Request budgets are shared per member and organization; a 429 response includes `Retry-After` in seconds. A temporarily unavailable API contract can also return 503 on any operation.\n" }, "servers": [ { "url": "https://api.parkes.ai" } ], "security": [ { "bearer": [] } ], "paths": { "/rest/v1/me": { "get": { "operationId": "getMe", "parameters": [], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMeResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [] }, { "bearer": [] } ], "x-required-scopes": [ [] ], "description": "Required scopes (OAuth and personal tokens): an authenticated organization-bound credential. Resource permissions also apply.", "tags": [ "Identity" ], "summary": "Get authenticated identity" } }, "/rest/v1/organizations": { "get": { "operationId": "listOrganizations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "organizations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "organizations:read" ] ], "description": "Required scopes (OAuth and personal tokens): organizations:read. Resource permissions also apply.", "tags": [ "Organizations" ], "summary": "List organizations" } }, "/rest/v1/organizations/{id}": { "get": { "operationId": "getOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "organizations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "organizations:read" ] ], "description": "Required scopes (OAuth and personal tokens): organizations:read. Resource permissions also apply.", "tags": [ "Organizations" ], "summary": "Get organization" } }, "/rest/v1/skills": { "get": { "operationId": "listSkills", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSkillsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:read" ] ], "description": "Required scopes (OAuth and personal tokens): skills:read. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "List skills" }, "post": { "operationId": "createSkill", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSkillResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillCreate" } } } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "description": "Required scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Create skill" } }, "/rest/v1/skills/{id}": { "get": { "operationId": "getSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSkillResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:read" ] ], "description": "Required scopes (OAuth and personal tokens): skills:read. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Get skill" }, "patch": { "operationId": "updateSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSkillResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillInput" } } } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "description": "Required scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Update skill" }, "delete": { "operationId": "deleteSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSkillResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "description": "Required scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Delete skill" } }, "/rest/v1/skills/{id}/fork": { "post": { "operationId": "forkSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForkSkillResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "description": "Required scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Fork skill" } }, "/rest/v1/skills/{id}/restore": { "post": { "operationId": "restoreSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreSkillResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "description": "Required scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "tags": [ "Skills" ], "summary": "Restore skill" } }, "/rest/v1/knowledge/documents": { "get": { "operationId": "listDocuments", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "namespace_id", "in": "query", "schema": { "type": "string" } }, { "name": "path", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDocumentsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "List documents" }, "post": { "operationId": "createDocument", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCreate" } } } }, "security": [ { "oauth": [ "knowledge:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:write" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:write. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "Create document" } }, "/rest/v1/knowledge/documents/{id}": { "get": { "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "Get document" }, "patch": { "operationId": "updateDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDocumentResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUpdate" } } } }, "security": [ { "oauth": [ "knowledge:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:write" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:write. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "Update document" } }, "/rest/v1/knowledge/documents/{id}/archive": { "post": { "operationId": "archiveDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveDocumentResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:write" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:write. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "Archive document" } }, "/rest/v1/knowledge/documents/{id}/history": { "get": { "operationId": "documentHistory", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentHistoryResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "List document history" } }, "/rest/v1/knowledge/documents/{id}/versions/{version}": { "get": { "operationId": "getDocumentVersion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentVersionResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "Get document version" } }, "/rest/v1/knowledge/documents/{id}/links": { "get": { "operationId": "linksDocuments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinksDocumentsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "List outgoing document links" } }, "/rest/v1/knowledge/documents/{id}/backlinks": { "get": { "operationId": "backlinksDocuments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacklinksDocumentsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "description": "Required scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "tags": [ "Knowledge" ], "summary": "List incoming document links" } }, "/rest/v1/knowledge/namespaces": { "get": { "operationId": "listNamespaces", "description": "Requires knowledge:read.\n\nRequired scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNamespacesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "tags": [ "Knowledge" ], "summary": "List namespaces" } }, "/rest/v1/knowledge/namespaces/{id}": { "get": { "operationId": "getNamespace", "description": "Requires knowledge:read.\n\nRequired scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNamespaceResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "tags": [ "Knowledge" ], "summary": "Get namespace" } }, "/rest/v1/knowledge/tree": { "get": { "operationId": "getKnowledgeTree", "description": "Requires knowledge:read.\n\nRequired scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "namespace_id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetKnowledgeTreeResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "tags": [ "Knowledge" ], "summary": "Get knowledge tree" } }, "/rest/v1/knowledge/search": { "get": { "operationId": "searchKnowledge", "description": "Requires knowledge:read. Returns the highest-ranked matches, bounded to 100; no continuation cursor.\n\nRequired scopes (OAuth and personal tokens): knowledge:read. Resource permissions also apply.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "description": "Maximum number of results to return in this page." }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "namespace_id", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "path", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchKnowledgeResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "knowledge:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:read" ] ], "tags": [ "Knowledge" ], "summary": "Search knowledge" } }, "/rest/v1/knowledge/documents/{id}/edits": { "post": { "operationId": "editDocument", "description": "Requires knowledge:write.\n\nRequired scopes (OAuth and personal tokens): knowledge:write. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditDocumentResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentEdits" } } } }, "security": [ { "oauth": [ "knowledge:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "knowledge:write" ] ], "tags": [ "Knowledge" ], "summary": "Edit document" } }, "/rest/v1/personal-tokens": { "get": { "operationId": "listPersonalTokens", "description": "Requires current user.\n\nRequired scopes (OAuth and personal tokens): an authenticated organization-bound credential. Resource permissions also apply.", "parameters": [ { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPersonalTokensResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [] }, { "bearer": [] } ], "x-required-scopes": [ [] ], "tags": [ "Personal tokens" ], "summary": "List personal tokens" }, "post": { "operationId": "createPersonalToken", "description": "Requires recent first-party authentication.\n\nRequired scopes (OAuth and personal tokens): an authenticated organization-bound credential. Resource permissions also apply.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalTokenResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalTokenInput" } } } }, "security": [ { "oauth": [] }, { "bearer": [] } ], "x-required-scopes": [ [] ], "tags": [ "Personal tokens" ], "summary": "Create personal token" } }, "/rest/v1/personal-tokens/{id}": { "get": { "operationId": "getPersonalToken", "description": "Requires current user.\n\nRequired scopes (OAuth and personal tokens): an authenticated organization-bound credential. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPersonalTokenResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [] }, { "bearer": [] } ], "x-required-scopes": [ [] ], "tags": [ "Personal tokens" ], "summary": "Get personal token" }, "delete": { "operationId": "revokePersonalToken", "description": "Requires current user.\n\nRequired scopes (OAuth and personal tokens): an authenticated organization-bound credential. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokePersonalTokenResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [] }, { "bearer": [] } ], "x-required-scopes": [ [] ], "tags": [ "Personal tokens" ], "summary": "Revoke personal token" } }, "/rest/v1/integrations": { "get": { "operationId": "listIntegrations", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIntegrationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "List integrations" } }, "/rest/v1/integrations/{slug}": { "get": { "operationId": "getIntegration", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "Get integration" } }, "/rest/v1/integrations/{slug}/enable": { "post": { "operationId": "enableIntegration", "description": "Requires integrations:write.\n\nRequired scopes (OAuth and personal tokens): integrations:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableIntegrationResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:write" ] ], "tags": [ "Integrations" ], "summary": "Enable integration" }, "delete": { "operationId": "disableIntegration", "description": "Requires integrations:write.\n\nRequired scopes (OAuth and personal tokens): integrations:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableIntegrationResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:write" ] ], "tags": [ "Integrations" ], "summary": "Disable integration" } }, "/rest/v1/integrations/{slug}/tools": { "get": { "operationId": "listIntegrationTools", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIntegrationToolsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "List integration tools" } }, "/rest/v1/integrations/{slug}/tools/{key}": { "get": { "operationId": "getIntegrationTool", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "path", "name": "key", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationToolResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "Get integration tool" } }, "/rest/v1/integrations/{slug}/triggers": { "get": { "operationId": "listIntegrationTriggers", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIntegrationTriggersResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "List integration triggers" } }, "/rest/v1/integrations/{slug}/triggers/{key}": { "get": { "operationId": "getIntegrationTrigger", "description": "Requires integrations:read.\n\nRequired scopes (OAuth and personal tokens): integrations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "slug", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "path", "name": "key", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetIntegrationTriggerResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "integrations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "integrations:read" ] ], "tags": [ "Integrations" ], "summary": "Get integration trigger" } }, "/rest/v1/connections": { "get": { "operationId": "listConnections", "description": "Requires connections:read.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListConnectionsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "List connections" }, "post": { "operationId": "createConnectionSession", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionSessionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionCreate" } } } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Create connection session" } }, "/rest/v1/connections/{id}": { "get": { "operationId": "getConnection", "description": "Requires connections:read.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "Get connection" }, "patch": { "operationId": "updateConnection", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionUpdate" } } } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Update connection" }, "delete": { "operationId": "disconnectConnection", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisconnectConnectionResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Disconnect connection" } }, "/rest/v1/connections/{id}/reconnect": { "post": { "operationId": "reconnectConnection", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconnectConnectionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Reconnect connection" } }, "/rest/v1/connections/{id}/tools": { "get": { "operationId": "getConnectionTools", "description": "Requires connections:read.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectionToolsResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "Get connection tools" }, "patch": { "operationId": "updateConnectionTools", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionToolsResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionToolsInput" } } } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Update connection tools" } }, "/rest/v1/connection-sessions/{id}": { "get": { "operationId": "getConnectionSession", "description": "Requires connections:read.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectionSessionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "Get connection session" }, "delete": { "operationId": "cancelConnectionSession", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelConnectionSessionResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Cancel connection session" } }, "/rest/v1/skills/{id}/sharing": { "get": { "operationId": "getSkillsSharing", "description": "Requires skills read and ownership.\n\nRequired scopes (OAuth and personal tokens): skills:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:read" ] ], "tags": [ "Skills" ], "summary": "Get skill sharing" }, "put": { "operationId": "setSkillsSharing", "description": "Requires skills write and ownership.\n\nRequired scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharing" } } } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "tags": [ "Skills" ], "summary": "Set skill sharing" }, "delete": { "operationId": "clearSkillsSharing", "description": "Requires skills write and ownership.\n\nRequired scopes (OAuth and personal tokens): skills:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "skills:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:write" ] ], "tags": [ "Skills" ], "summary": "Clear skill sharing" } }, "/rest/v1/connections/{id}/sharing": { "get": { "operationId": "getConnectionsSharing", "description": "Requires connections read and ownership.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "Get connection sharing" }, "put": { "operationId": "setConnectionsSharing", "description": "Requires connections write and ownership.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsSharing" } } } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Set connection sharing" }, "delete": { "operationId": "clearConnectionsSharing", "description": "Requires connections write and ownership.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Clear connection sharing" } }, "/rest/v1/automations": { "get": { "operationId": "listAutomations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAutomationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "List automations" }, "post": { "operationId": "createAutomation", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationCreate" } } } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Create automation" } }, "/rest/v1/automations/{automation_id}": { "get": { "operationId": "getAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutomationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "Get automation" }, "patch": { "operationId": "updateAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationUpdate" } } } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Update automation" }, "delete": { "operationId": "deleteAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAutomationResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Delete automation" } }, "/rest/v1/automations/{automation_id}/enable": { "post": { "operationId": "enableAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableAutomationResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Enable automation" } }, "/rest/v1/automations/{automation_id}/disable": { "post": { "operationId": "disableAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableAutomationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Disable automation" } }, "/rest/v1/automations/{automation_id}/runs": { "post": { "operationId": "runAutomation", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunAutomationResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:execute.\n\nRequired scopes (OAuth and personal tokens): automations:execute. Resource permissions also apply.", "security": [ { "oauth": [ "automations:execute" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:execute" ] ], "tags": [ "Automations" ], "summary": "Run automation" }, "get": { "operationId": "listAutomationRuns", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAutomationRunsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "List automation runs" } }, "/rest/v1/automations/{automation_id}/runs/{run_id}": { "get": { "operationId": "getAutomationRun", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutomationRunResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "Get automation run" } }, "/rest/v1/operations/{operation_id}": { "get": { "operationId": "getOperation", "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOperationResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires the operation’s originating scope.\n\nRequired scopes (OAuth and personal tokens): activity:write or automations:write or users:manage or marketplace:write or connections:write. Resource permissions also apply. The scope must match the referenced resource; holding another listed alternative is insufficient.", "security": [ { "oauth": [ "activity:write" ] }, { "oauth": [ "automations:write" ] }, { "oauth": [ "users:manage" ] }, { "oauth": [ "marketplace:write" ] }, { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:write" ], [ "automations:write" ], [ "users:manage" ], [ "marketplace:write" ], [ "connections:write" ] ], "tags": [ "Operations" ], "summary": "Get operation" } }, "/rest/v1/automations/{id}/sharing": { "get": { "operationId": "getAutomationsSharing", "description": "Requires skills read and ownership.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "Get automation sharing" }, "put": { "operationId": "setAutomationsSharing", "description": "Requires automations write and ownership.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationsSharing" } } } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Set automation sharing" }, "delete": { "operationId": "clearAutomationsSharing", "description": "Requires skills write and ownership.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillsSharingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Clear automation sharing" } }, "/rest/v1/automations/{automation_id}/triggers": { "get": { "operationId": "listAutomationTriggers", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAutomationTriggersResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "List automation triggers" }, "post": { "operationId": "createAutomationTrigger", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationTriggerCreate" } } } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Create automation trigger" } }, "/rest/v1/automations/{automation_id}/triggers/{trigger_id}": { "get": { "operationId": "getAutomationTrigger", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ], "summary": "Get automation trigger" }, "patch": { "operationId": "updateAutomationTrigger", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationTriggerUpdate" } } } }, "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Update automation trigger" }, "delete": { "operationId": "deleteAutomationTrigger", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "trigger_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAutomationTriggerResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:write.\n\nRequired scopes (OAuth and personal tokens): automations:write. Resource permissions also apply.", "security": [ { "oauth": [ "automations:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:write" ] ], "tags": [ "Automations" ], "summary": "Delete automation trigger" } }, "/rest/v1/skills/{id}/run": { "post": { "operationId": "executeSkill", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecuteSkillResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires skills:execute.\n\nRequired scopes (OAuth and personal tokens): skills:execute. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkillExecution" } } } }, "security": [ { "oauth": [ "skills:execute" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:execute" ] ], "tags": [ "Skills" ], "summary": "Execute skill" } }, "/rest/v1/runs/{id}": { "get": { "operationId": "getRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRunResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires skills:read with conversation read permission, or automations:read with associated automation read permission for automation runs.\n\nRequired scopes (OAuth and personal tokens): skills:read or automations:read. Resource permissions also apply. The scope must match the referenced resource; holding another listed alternative is insufficient.", "security": [ { "oauth": [ "skills:read" ] }, { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:read" ], [ "automations:read" ] ], "tags": [ "Runs" ], "summary": "Get run" } }, "/rest/v1/runs/{id}/logs": { "get": { "operationId": "listRunLogs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRunLogsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires skills:read with conversation read permission, or automations:read with associated automation read permission for automation runs.\n\nRequired scopes (OAuth and personal tokens): skills:read or automations:read. Resource permissions also apply. The scope must match the referenced resource; holding another listed alternative is insufficient.", "security": [ { "oauth": [ "skills:read" ] }, { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "skills:read" ], [ "automations:read" ] ], "tags": [ "Runs" ], "summary": "List run logs" } }, "/rest/v1/users": { "get": { "operationId": "listUsers", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires users:read.\n\nRequired scopes (OAuth and personal tokens): users:read. Resource permissions also apply.", "security": [ { "oauth": [ "users:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:read" ] ], "tags": [ "Members" ], "summary": "List users" } }, "/rest/v1/users/{id}": { "get": { "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires users:read.\n\nRequired scopes (OAuth and personal tokens): users:read. Resource permissions also apply.", "security": [ { "oauth": [ "users:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:read" ] ], "tags": [ "Members" ], "summary": "Get user" }, "patch": { "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires users:manage and an organization administrator.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberUpdate" } } } }, "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Members" ], "summary": "Update user" } }, "/rest/v1/users/{id}/suspend": { "post": { "operationId": "suspendUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuspendUserResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires users:manage and an organization administrator.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Members" ], "summary": "Suspend user" } }, "/rest/v1/users/{id}/activate": { "post": { "operationId": "activateUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateUserResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires users:manage and an organization administrator.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Members" ], "summary": "Activate user" } }, "/rest/v1/invitations": { "get": { "operationId": "listInvitations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInvitationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires an organization administrator and users:read.\n\nRequired scopes (OAuth and personal tokens): users:read. Resource permissions also apply.", "security": [ { "oauth": [ "users:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:read" ] ], "tags": [ "Invitations" ], "summary": "List invitations" }, "post": { "operationId": "createInvitation", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvitationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires an organization administrator and users:manage.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationCreate" } } } }, "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Invitations" ], "summary": "Create invitation" } }, "/rest/v1/invitations/{id}": { "get": { "operationId": "getInvitation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvitationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires an organization administrator and users:read.\n\nRequired scopes (OAuth and personal tokens): users:read. Resource permissions also apply.", "security": [ { "oauth": [ "users:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:read" ] ], "tags": [ "Invitations" ], "summary": "Get invitation" }, "delete": { "operationId": "revokeInvitation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeInvitationResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires an organization administrator and users:manage.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Invitations" ], "summary": "Revoke invitation" } }, "/rest/v1/invitations/{id}/resend": { "post": { "operationId": "resendInvitation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendInvitationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires an organization administrator and users:manage.\n\nRequired scopes (OAuth and personal tokens): users:manage. Resource permissions also apply.", "security": [ { "oauth": [ "users:manage" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "users:manage" ] ], "tags": [ "Invitations" ], "summary": "Resend invitation" } }, "/rest/v1/models": { "get": { "operationId": "listModels", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListModelsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires models:read. Only selectable models allowed by the organization are visible.\n\nRequired scopes (OAuth and personal tokens): models:read. Resource permissions also apply.", "security": [ { "oauth": [ "models:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "models:read" ] ], "tags": [ "Models" ], "summary": "List models" } }, "/rest/v1/models/{id}": { "get": { "operationId": "getModel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetModelResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires models:read. Only selectable models allowed by the organization are visible.\n\nRequired scopes (OAuth and personal tokens): models:read. Resource permissions also apply.", "security": [ { "oauth": [ "models:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "models:read" ] ], "tags": [ "Models" ], "summary": "Get model" } }, "/rest/v1/activity": { "get": { "operationId": "listActivity", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "event_type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "origin", "in": "query", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListActivityResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:read. Administrators see organization activity; members see activity attributed to themselves.\n\nRequired scopes (OAuth and personal tokens): activity:read. Resource permissions also apply.", "security": [ { "oauth": [ "activity:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:read" ] ], "tags": [ "Activity" ], "summary": "List activity" } }, "/rest/v1/activity/{id}": { "get": { "operationId": "getActivity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActivityResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:read. Administrators see organization activity; members see activity attributed to themselves.\n\nRequired scopes (OAuth and personal tokens): activity:read. Resource permissions also apply.", "security": [ { "oauth": [ "activity:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:read" ] ], "tags": [ "Activity" ], "summary": "Get activity" } }, "/rest/v1/marketplace/listings": { "get": { "operationId": "listMarketplaceListings", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "owned", "in": "query", "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 200 } }, { "name": "kind", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "integration", "in": "query", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "schema": { "type": "string" } }, { "name": "collection", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceListingsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace listings" }, "post": { "operationId": "createMarketplaceListing", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceListingResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceListingCreate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Create marketplace listing" } }, "/rest/v1/marketplace/listings/{id}": { "get": { "operationId": "getMarketplaceListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceListingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace listing" } }, "/rest/v1/marketplace/listings/{id}/unlist": { "post": { "operationId": "unlistMarketplaceListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlistMarketplaceListingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:publish and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:publish. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:publish" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:publish" ] ], "tags": [ "Marketplace" ], "summary": "Unlist marketplace listing" } }, "/rest/v1/marketplace/listings/{id}/relist": { "post": { "operationId": "relistMarketplaceListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelistMarketplaceListingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:publish and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:publish. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:publish" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:publish" ] ], "tags": [ "Marketplace" ], "summary": "Relist marketplace listing" } }, "/rest/v1/marketplace/listings/{id}/archive": { "post": { "operationId": "archiveMarketplaceListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveMarketplaceListingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:publish and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:publish. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:publish" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:publish" ] ], "tags": [ "Marketplace" ], "summary": "Archive marketplace listing" } }, "/rest/v1/marketplace/listings/{id}/withdraw": { "post": { "operationId": "withdrawMarketplaceListing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithdrawMarketplaceListingResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:publish and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:publish. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceWithdrawal" } } } }, "security": [ { "oauth": [ "marketplace:publish" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:publish" ] ], "tags": [ "Marketplace" ], "summary": "Withdraw marketplace listing" } }, "/rest/v1/marketplace/listings/{listing_id}/releases": { "get": { "operationId": "listMarketplaceReleases", "parameters": [ { "name": "listing_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceReleasesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace releases" } }, "/rest/v1/marketplace/releases/{id}": { "get": { "operationId": "getMarketplaceRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceReleaseResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace release" }, "patch": { "operationId": "updateMarketplaceRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMarketplaceReleaseResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceEditorial" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Update marketplace release" }, "delete": { "operationId": "deleteMarketplaceRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMarketplaceReleaseResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Delete marketplace release" } }, "/rest/v1/marketplace/releases": { "post": { "operationId": "createMarketplaceRelease", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceReleaseResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceReleaseCreate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Create marketplace release" } }, "/rest/v1/marketplace/releases/{id}/validate": { "post": { "operationId": "validateMarketplaceRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateMarketplaceReleaseResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Validate marketplace release" } }, "/rest/v1/marketplace/releases/{id}/publish": { "post": { "operationId": "publishMarketplaceRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishMarketplaceReleaseResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:publish and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:publish. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:publish" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:publish" ] ], "tags": [ "Marketplace" ], "summary": "Publish marketplace release" } }, "/rest/v1/marketplace/categories": { "get": { "operationId": "listMarketplaceCategories", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceCategoriesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace categories" } }, "/rest/v1/marketplace/publishers": { "get": { "operationId": "listMarketplacePublishers", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplacePublishersResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace publishers" } }, "/rest/v1/marketplace/sources": { "get": { "operationId": "listMarketplaceSources", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "kind", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "skill", "automation", "rule", "knowledge" ] } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceSourcesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and publishing access; lists only publishable sources.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace sources" } }, "/rest/v1/marketplace/publishers/{id}": { "get": { "operationId": "getMarketplacePublisher", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplacePublisherResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace publisher" } }, "/rest/v1/marketplace/releases/{release_id}/items": { "get": { "operationId": "listMarketplaceItems", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceItemsResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace items" }, "post": { "operationId": "addMarketplaceItem", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMarketplaceItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceItemCreate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Add marketplace item" } }, "/rest/v1/marketplace/releases/{release_id}/items/{id}": { "patch": { "operationId": "updateMarketplaceItem", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMarketplaceItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceItemUpdate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Update marketplace item" }, "delete": { "operationId": "removeMarketplaceItem", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveMarketplaceItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Remove marketplace item" }, "get": { "operationId": "getMarketplaceItem", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace item" } }, "/rest/v1/marketplace/releases/{release_id}/items/{id}/refresh": { "post": { "operationId": "refreshMarketplaceItem", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshMarketplaceItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Refresh marketplace item" } }, "/rest/v1/marketplace/releases/{release_id}/items/reorder": { "post": { "operationId": "reorderMarketplaceItems", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderMarketplaceItemsResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceItemOrder" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Reorder marketplace items" } }, "/rest/v1/marketplace/installations": { "get": { "operationId": "listMarketplaceInstallations", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMarketplaceInstallationsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "List marketplace installations" }, "post": { "operationId": "createMarketplaceInstallation", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMarketplaceInstallationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallationCreate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Create marketplace installation" } }, "/rest/v1/marketplace/installations/{id}": { "get": { "operationId": "getMarketplaceInstallation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceInstallationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace installation" }, "patch": { "operationId": "updateMarketplaceInstallation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMarketplaceInstallationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallationUpdate" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Update marketplace installation" }, "delete": { "operationId": "removeMarketplaceInstallation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveMarketplaceInstallationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallationRemove" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Remove marketplace installation" } }, "/rest/v1/marketplace/installations/{id}/transfer": { "post": { "operationId": "transferMarketplaceInstallation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferMarketplaceInstallationResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceInstallationTransfer" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Transfer marketplace installation" } }, "/rest/v1/marketplace/installations/{id}/preview-update": { "get": { "operationId": "previewMarketplaceInstallationUpdate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "release_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewMarketplaceInstallationUpdateResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Preview marketplace installation update" } }, "/rest/v1/marketplace/installations/{id}/preview-remove": { "get": { "operationId": "previewMarketplaceInstallationRemoval", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewMarketplaceInstallationRemovalResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and installation permissions. Updates and removal require the preview digest and an explicit choice for every item.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Preview marketplace installation removal" } }, "/rest/v1/marketplace/releases/{release_id}/artwork/{kind}": { "post": { "operationId": "uploadMarketplaceArtwork", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "cover", "thumbnail" ] }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadMarketplaceArtworkResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write. Upload accepts base64 image bytes up to 5 MiB; decoding, metadata removal and attachment run as a durable operation.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply. The JSON request body may be at most 8 MiB. Base64-decoded artwork must be between 1 byte and 5 MiB.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceArtworkUpload" } } } }, "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Upload marketplace artwork" }, "delete": { "operationId": "deleteMarketplaceArtwork", "parameters": [ { "name": "release_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "kind", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "cover", "thumbnail" ] }, "description": "Identifier of the requested resource." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMarketplaceArtworkResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:write. Upload accepts base64 image bytes up to 5 MiB; decoding, metadata removal and attachment run as a durable operation.\n\nRequired scopes (OAuth and personal tokens): marketplace:write. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:write" ] ], "tags": [ "Marketplace" ], "summary": "Delete marketplace artwork" } }, "/rest/v1/marketplace/listings/{id}/analytics": { "get": { "operationId": "getMarketplaceAnalytics", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "days", "in": "query", "schema": { "type": "integer", "enum": [ 7, 30, 90 ], "default": 30 } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceAnalyticsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires marketplace:read and applicable Marketplace permissions.\n\nRequired scopes (OAuth and personal tokens): marketplace:read. Resource permissions also apply.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace analytics" } }, "/rest/v1/connections/{id}/sync": { "get": { "operationId": "getConnectionSync", "description": "Requires connections:read.\n\nRequired scopes (OAuth and personal tokens): connections:read. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConnectionSyncResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "connections:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:read" ] ], "tags": [ "Connections" ], "summary": "Get connection sync" }, "patch": { "operationId": "updateConnectionSync", "description": "Requires connections:write.\n\nRequired scopes (OAuth and personal tokens): connections:write. Resource permissions also apply.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionSyncResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionSyncWrite" } } } }, "security": [ { "oauth": [ "connections:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "connections:write" ] ], "tags": [ "Connections" ], "summary": "Update connection sync" } }, "/rest/v1/automations/{automation_id}/runs/{id}/logs": { "get": { "operationId": "listAutomationRunLogs", "parameters": [ { "name": "automation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "Identifier of the requested resource." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRunLogsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires automations:read and automation visibility. Only the associated automation conversation transcript is exposed, matching Console.\n\nRequired scopes (OAuth and personal tokens): automations:read. Resource permissions also apply.", "summary": "List automation run logs", "security": [ { "oauth": [ "automations:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "automations:read" ] ], "tags": [ "Automations" ] } }, "/rest/v1/activity/archives": { "get": { "operationId": "listActivityArchives", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListActivityArchivesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:read and organization administrator permissions. Archive files and cross-organization totals are never exposed.\n\nRequired scopes (OAuth and personal tokens): activity:read. Resource permissions also apply.", "security": [ { "oauth": [ "activity:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:read" ] ], "tags": [ "Activity" ], "summary": "List activity archives" } }, "/rest/v1/activity/archives/{id}": { "get": { "operationId": "getActivityArchive", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActivityArchiveResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:read and organization administrator permissions. Archive files and cross-organization totals are never exposed.\n\nRequired scopes (OAuth and personal tokens): activity:read. Resource permissions also apply.", "security": [ { "oauth": [ "activity:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:read" ] ], "tags": [ "Activity" ], "summary": "Get activity archive" } }, "/rest/v1/activity/archives/{id}/hydrate": { "post": { "operationId": "hydrateActivityArchive", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOperationResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:write and organization administrator permissions. Archive files and cross-organization totals are never exposed.\n\nRequired scopes (OAuth and personal tokens): activity:write. Resource permissions also apply.", "security": [ { "oauth": [ "activity:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:write" ] ], "tags": [ "Activity" ], "summary": "Hydrate activity archive" } }, "/rest/v1/activity/tail": { "get": { "operationId": "tailActivity", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "name": "event_type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "origin", "in": "query", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TailActivityResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "410": { "$ref": "#/components/responses/CursorExpired" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Requires activity:read. Without a cursor starts at the current ingestion position. Poll with the returned cursor, which expires after 24 hours. Delivery is at least once: deduplicate delivery_id, not event id. Publication follows committed transactions, typically within five seconds. Imported archive rows are not replayed. Retention is seven days. Filtered empty pages can advance the cursor. has_more allows immediate continuation.\n\nRequired scopes (OAuth and personal tokens): activity:read. Resource permissions also apply.", "security": [ { "oauth": [ "activity:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "activity:read" ] ], "tags": [ "Activity" ], "summary": "Tail activity" } }, "/rest/v1/library/items": { "get": { "operationId": "listLibraryItems", "description": "Requires library:read. Resource permissions also apply.", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "folder_id", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "file_type", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "modified", "name", "size" ] } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLibraryItemsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:read" ] ], "tags": [ "Library" ], "summary": "List library items" } }, "/rest/v1/library/items/{id}": { "get": { "operationId": "getLibraryItem", "description": "Requires library:read. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLibraryItemResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:read" ] ], "tags": [ "Library" ], "summary": "Get library item" }, "delete": { "operationId": "deleteLibraryItem", "description": "Requires library:write. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteLibraryItemResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:write" ] ], "tags": [ "Library" ], "summary": "Delete library item" } }, "/rest/v1/library/items/{id}/content": { "get": { "operationId": "getLibraryItemContent", "description": "Requires library:read. Resource permissions also apply.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLibraryItemContentResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:read" ] ], "tags": [ "Library" ], "summary": "Get library item content" } }, "/rest/v1/library/items/{item_id}/share_links": { "post": { "operationId": "createLibraryShareLink", "description": "Requires library:write. Resource permissions also apply.", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLibraryShareLinkResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:write" ] ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibraryShareInput" } } } }, "tags": [ "Library" ], "summary": "Create library share link" } }, "/rest/v1/library/folders": { "get": { "operationId": "listLibraryFolders", "description": "Requires library:read. Resource permissions also apply.", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." }, { "name": "parent_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLibraryFoldersResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "library:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "library:read" ] ], "tags": [ "Library" ], "summary": "List library folders" } }, "/rest/v1/agent/runs": { "post": { "operationId": "createAgentRun", "description": "Admit or resume an AG-UI run. Idempotency-Key protects admission; runId also permanently identifies the input within its thread. Personal tokens create unattended runs and cannot resolve interactions. Stream events using the returned relative events_path.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentRunInput" } } } }, "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentRunResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "agent:execute" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "agent:execute" ] ], "tags": [ "Agent runs" ], "summary": "Create agent run" } }, "/rest/v1/agent/runs/{id}/events": { "get": { "operationId": "streamAgentRunEvents", "description": "AG-UI JSON events in SSE frames. Last-Event-ID resumes after an event belonging to this run. Disconnecting does not cancel execution. Access is rechecked during streaming.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Last-Event-ID", "in": "header", "schema": { "type": "string" } } ], "responses": { "200": { "description": "AG-UI server-sent events. After the stream opens, failures are conveyed through the stream or connection closure, not a second HTTP response.", "content": { "text/event-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "agent:execute" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "agent:execute" ] ], "tags": [ "Agent runs" ], "summary": "Stream agent run events" } }, "/rest/v1/community/spaces": { "get": { "operationId": "listCommunitySpaces", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommunitySpacesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "List community spaces" } }, "/rest/v1/community/spaces/{space_id}/join": { "post": { "operationId": "joinCommunitySpace", "description": "Requires community:write. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinCommunitySpaceResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:write" ] ], "tags": [ "Community" ], "summary": "Join community space" } }, "/rest/v1/community/spaces/{space_id}/posts": { "get": { "operationId": "listCommunityPosts", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommunityPostsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "List community posts" } }, "/rest/v1/community/spaces/{space_id}/posts/{post_id}": { "get": { "operationId": "getCommunityPost", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommunityPostResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETag" } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "Get community post" } }, "/rest/v1/community/spaces/{space_id}/posts/{post_id}/comments": { "get": { "operationId": "listCommunityComments", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommunityCommentsResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "List community comments" }, "post": { "operationId": "createCommunityComment", "description": "Requires community:write. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommunityCommentResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:write" ] ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunityCommentInput" } } } }, "tags": [ "Community" ], "summary": "Create community comment" } }, "/rest/v1/community/spaces/{space_id}/posts/{post_id}/comments/{comment_id}/replies": { "get": { "operationId": "listCommunityReplies", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "comment_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "description": "Maximum number of results to return in this page." }, { "in": "query", "name": "cursor", "schema": { "type": "string" }, "description": "Opaque cursor from page.next_cursor. Keep the original filters unchanged when requesting the next page." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCommunityRepliesResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "List community replies" } }, "/rest/v1/community/spaces/{space_id}/posts/{post_id}/reaction": { "put": { "operationId": "setCommunityReaction", "description": "Requires community:write. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCommunityReactionResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:write" ] ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunityReactionInput" } } } }, "tags": [ "Community" ], "summary": "Set community reaction" }, "delete": { "operationId": "removeCommunityReaction", "description": "Requires community:write. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Current ETag of the resource being changed. Fetch it before submitting this mutation." } ], "responses": { "202": { "description": "Accepted for processing; completion is not yet confirmed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveCommunityReactionResponse" } } }, "headers": { "Location": { "$ref": "#/components/headers/Location" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "412": { "$ref": "#/components/responses/PreconditionFailed" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "428": { "$ref": "#/components/responses/PreconditionRequired" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:write" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:write" ] ], "tags": [ "Community" ], "summary": "Remove community reaction" } }, "/rest/v1/marketplace/storefront": { "get": { "operationId": "getMarketplaceStorefront", "parameters": [], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMarketplaceStorefrontResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "description": "Curated public Marketplace collections and featured listings.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Marketplace" ], "summary": "Get marketplace storefront" } }, "/rest/v1/community/spaces/{space_id}": { "get": { "operationId": "getCommunitySpace", "description": "Requires community:read. Circle identifiers are opaque strings. Collections wrap provider pagination in signed, expiring cursors. External mutations return an operation; uncertain outcomes are never automatically retried.", "parameters": [ { "name": "space_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCommunitySpaceResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "oauth": [ "community:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "community:read" ] ], "tags": [ "Community" ], "summary": "Get community space" } }, "/rest/v1/notification-tokens": { "post": { "operationId": "registerNotificationToken", "description": "Register the signed-in device's APNs token so Parkes can push the outcome of agent runs the app starts. A token belongs to whichever user registered it last.\n\nRequired scopes (OAuth only): notifications:write. Personal tokens cannot hold this scope.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTokenInput" } } } }, "responses": { "201": { "description": "The resource was created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterNotificationTokenResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "415": { "$ref": "#/components/responses/UnsupportedMediaType" }, "422": { "$ref": "#/components/responses/UnprocessableContent" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "notifications:write" ] } ], "x-required-scopes": [ [ "notifications:write" ] ], "tags": [ "Notifications" ], "summary": "Register notification token" } }, "/rest/v1/notification-tokens/{token}": { "delete": { "operationId": "unregisterNotificationToken", "description": "Stop push notifications to a device the user registered, such as on sign-out.\n\nRequired scopes (OAuth only): notifications:write. Personal tokens cannot hold this scope.", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Identifier of the requested resource." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string" }, "description": "A unique key for this logical mutation (at most 128 bytes). Reuse it only when retrying the same request. Required for POST; optional for other mutations." } ], "responses": { "200": { "description": "Request completed successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnregisterNotificationTokenResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "413": { "$ref": "#/components/responses/ContentTooLarge" }, "429": { "$ref": "#/components/responses/TooManyRequests" } }, "security": [ { "oauth": [ "notifications:write" ] } ], "x-required-scopes": [ [ "notifications:write" ] ], "tags": [ "Notifications" ], "summary": "Unregister notification token" } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" }, "oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "refreshUrl": "/oauth/token", "scopes": { "organizations:read": "Organizations read", "integrations:read": "Integrations read", "integrations:write": "Integrations write", "connections:read": "Connections read", "connections:write": "Connections write", "skills:read": "Skills read", "skills:write": "Skills write", "skills:execute": "Skills execute", "automations:read": "Automations read", "automations:write": "Automations write", "automations:execute": "Automations execute", "knowledge:read": "Knowledge read", "knowledge:write": "Knowledge write", "marketplace:read": "Marketplace read", "marketplace:write": "Marketplace write", "marketplace:publish": "Marketplace publish", "users:read": "Users read", "users:manage": "Users manage", "activity:read": "Activity read", "activity:write": "Activity write", "models:read": "Models read", "library:read": "Read Library files and folders", "library:write": "Delete Library files and create share links", "agent:execute": "Execute and observe agent conversations; browser OAuth may resolve interactions", "community:read": "Read Community spaces and discussions", "community:write": "Join spaces, comment, and react", "notifications:write": "Register this device for push notifications about the user's agent runs; granted only to the first-party iOS app" } } } } }, "schemas": { "Problem": { "type": "object", "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "code": { "type": "string" }, "detail": { "type": "string" }, "request_id": { "type": "string", "description": "Request identifier to include when reporting an API failure." }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "type", "title", "status", "code", "detail" ], "description": "A handled API failure. The HTTP status and status field agree; code identifies the failure category." }, "Me": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "organization_id": { "type": "string" }, "organization_user_id": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "email", "organization_id", "organization_user_id", "scopes" ] }, "Organization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "personal": { "type": "boolean" } }, "required": [ "id", "name", "personal" ] }, "Skill": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "prompt": { "type": "string" }, "owner_id": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "owner_id", "updated_at" ] }, "SkillInput": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "prompt": { "type": "string" } }, "additionalProperties": false }, "Document": { "type": "object", "properties": { "id": { "type": "string" }, "namespace_id": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "updated_at": { "type": "string" }, "content": { "type": "string", "nullable": true }, "version": { "type": "string" } }, "required": [ "id", "namespace_id", "path", "title", "kind", "status", "visibility", "updated_at" ] }, "DocumentInput": { "type": "object", "properties": { "namespace_id": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "edit_policy": { "type": "string" }, "content": { "type": "string" }, "expected_version": { "type": "string" }, "change_summary": { "type": "string" } }, "additionalProperties": false }, "Version": { "type": "object", "properties": { "id": { "type": "string" }, "version": { "type": "integer" }, "created_at": { "type": "string" }, "change_summary": { "type": "string", "nullable": true }, "content": { "type": "string" } }, "required": [ "id", "version" ] }, "Deletion": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" }, "archived": { "type": "boolean" }, "revoked": { "type": "boolean" } }, "required": [ "id" ] }, "GetMeResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Me" } }, "required": [ "data" ] }, "ListOrganizationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetOrganizationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Organization" } }, "required": [ "data" ] }, "ListSkillsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Skill" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "CreateSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Skill" } }, "required": [ "data" ] }, "GetSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Skill" } }, "required": [ "data" ] }, "UpdateSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Skill" } }, "required": [ "data" ] }, "DeleteSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deletion" } }, "required": [ "data" ] }, "ForkSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Skill" } }, "required": [ "data" ] }, "RestoreSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Skill" } }, "required": [ "data" ] }, "ListDocumentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "CreateDocumentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "required": [ "data" ] }, "GetDocumentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "required": [ "data" ] }, "UpdateDocumentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "required": [ "data" ] }, "ArchiveDocumentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deletion" } }, "required": [ "data" ] }, "DocumentHistoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Version" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetDocumentVersionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Version" } }, "required": [ "data" ] }, "LinksDocumentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "BacklinksDocumentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "Namespace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "default_access": { "type": "string" }, "owner_id": { "type": "string", "nullable": true } }, "required": [ "id", "name", "slug", "kind", "default_access", "owner_id" ] }, "ListNamespacesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Namespace" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetNamespaceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Namespace" } }, "required": [ "data" ] }, "TreeEntry": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "path", "title" ] }, "GetKnowledgeTreeResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TreeEntry" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "SearchHit": { "type": "object", "properties": { "id": { "type": "string" }, "namespace_id": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "updated_at": { "type": "string" }, "content": { "type": "string", "nullable": true }, "version": { "type": "string" }, "score": { "type": "number", "nullable": true }, "snippet": { "type": "string", "nullable": true } }, "required": [ "id", "namespace_id", "path", "title", "kind", "status", "visibility", "updated_at" ] }, "SearchKnowledgeResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchHit" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "DocumentEdits": { "type": "object", "properties": { "operations": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "oneOf": [ { "$ref": "#/components/schemas/ReplaceLineRange" }, { "$ref": "#/components/schemas/InsertAtLine" }, { "$ref": "#/components/schemas/DeleteLineRange" }, { "$ref": "#/components/schemas/ReplaceLiteral" } ] } }, "expected_version": { "type": "string" }, "change_summary": { "type": "string" } }, "required": [ "operations", "expected_version" ], "additionalProperties": false }, "EditDocumentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Document" } }, "required": [ "data" ] }, "PersonalToken": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": "string" }, "revoked_at": { "type": "string", "nullable": true }, "last_used_at": { "type": "string", "nullable": true }, "secret": { "type": "string" } }, "required": [ "id", "name", "prefix", "scopes", "expires_at", "revoked_at", "last_used_at" ] }, "PersonalTokenInput": { "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "expires_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "scopes" ], "additionalProperties": false }, "ListPersonalTokensResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalToken" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetPersonalTokenResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PersonalToken" } }, "required": [ "data" ] }, "CreatePersonalTokenResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PersonalToken" } }, "required": [ "data" ] }, "RevokePersonalTokenResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deletion" } }, "required": [ "data" ] }, "DocumentCreate": { "type": "object", "properties": { "namespace_id": { "type": "string" }, "path": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "edit_policy": { "type": "string" }, "content": { "type": "string" }, "change_summary": { "type": "string" } }, "required": [ "namespace_id", "path", "content" ], "additionalProperties": false }, "DocumentUpdate": { "type": "object", "properties": { "title": { "type": "string" }, "status": { "type": "string" }, "visibility": { "type": "string" }, "edit_policy": { "type": "string" }, "content": { "type": "string" }, "expected_version": { "type": "string" }, "change_summary": { "type": "string" } }, "required": [ "content", "expected_version" ], "additionalProperties": false }, "SkillCreate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "prompt": { "type": "string" } }, "required": [ "name", "description", "prompt" ], "additionalProperties": false }, "ReplaceLineRange": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "replace_line_range" ] }, "start_line": { "type": "integer", "minimum": 1 }, "end_line": { "type": "integer", "minimum": 1 }, "replacement": { "type": "string" } }, "required": [ "type", "start_line", "end_line", "replacement" ], "additionalProperties": false }, "InsertAtLine": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "insert_at_line" ] }, "line": { "type": "integer", "minimum": 1 }, "content": { "type": "string" }, "position": { "type": "string", "enum": [ "before", "after" ], "default": "after" } }, "required": [ "type", "line", "content" ], "additionalProperties": false }, "DeleteLineRange": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delete_line_range" ] }, "start_line": { "type": "integer", "minimum": 1 }, "end_line": { "type": "integer", "minimum": 1 } }, "required": [ "type", "start_line", "end_line" ], "additionalProperties": false }, "ReplaceLiteral": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "replace_literal" ] }, "find": { "type": "string" }, "replace": { "type": "string" }, "expected_count": { "type": "integer", "minimum": 0 } }, "required": [ "type", "find", "replace", "expected_count" ], "additionalProperties": false }, "Integration": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "categories": { "type": "array", "items": { "type": "string" } }, "logo_url": { "type": "string", "nullable": true }, "logo_dark_url": { "type": "string", "nullable": true }, "deprecated": { "type": "boolean" }, "connection_status": { "type": "string", "nullable": true }, "example_prompts": { "type": "array", "items": { "type": "string" } } }, "required": [ "slug", "name", "enabled" ] }, "IntegrationTool": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "input_schema": { "type": "object", "additionalProperties": true }, "annotations": { "type": "object", "additionalProperties": true } }, "required": [ "key" ] }, "IntegrationTrigger": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "input_schema": { "type": "object", "additionalProperties": true }, "events": { "type": "object", "additionalProperties": true } }, "required": [ "key" ] }, "ListIntegrationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Integration" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] }, "meta": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" } } }, "required": [ "categories" ] } }, "required": [ "data", "page" ] }, "GetIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } }, "required": [ "data" ] }, "EnableIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } }, "required": [ "data" ] }, "DisableIntegrationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Integration" } }, "required": [ "data" ] }, "ListIntegrationToolsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationTool" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetIntegrationToolResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationTool" } }, "required": [ "data" ] }, "ListIntegrationTriggersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationTrigger" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetIntegrationTriggerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationTrigger" } }, "required": [ "data" ] }, "Connection": { "type": "object", "properties": { "id": { "type": "string" }, "integration": { "type": "string" }, "owner_user_id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string" }, "updated_at": { "type": "string" }, "connected_at": { "type": "string", "nullable": true }, "external_account_id": { "type": "string", "nullable": true }, "owned": { "type": "boolean" }, "owner_name": { "type": "string" }, "integration_details": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "logo_url": { "type": "string", "nullable": true }, "logo_dark_url": { "type": "string", "nullable": true } }, "required": [ "slug", "name", "logo_url", "logo_dark_url" ] }, "example_prompts": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "integration", "owner_user_id", "name", "status", "updated_at" ] }, "ConnectionSession": { "type": "object", "properties": { "id": { "type": "string" }, "integration": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "successful", "failed", "expired", "cancelled" ] }, "connection_id": { "type": "string", "nullable": true }, "expires_at": { "type": "string" }, "authorization_url": { "type": "string" } }, "required": [ "id", "integration", "status", "connection_id", "expires_at", "authorization_url" ] }, "ConnectionCreate": { "type": "object", "properties": { "integration": { "type": "string" }, "name": { "type": "string", "maxLength": 80, "minLength": 1 } }, "required": [ "integration" ], "additionalProperties": false }, "ConnectionUpdate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80, "minLength": 1 } }, "required": [ "name" ], "additionalProperties": false }, "ConnectionTools": { "type": "object", "properties": { "rules": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "disabled", "approval", "auto" ] } }, "preset": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 6 }, "revision": { "type": "string" } }, "required": [ "rules", "preset", "revision" ] }, "ConnectionToolsInput": { "type": "object", "properties": { "rules": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "disabled", "approval", "auto" ] } }, "preset": { "type": "integer", "nullable": true, "minimum": 0, "maximum": 6 }, "revision": { "type": "string" } }, "required": [ "rules", "revision" ], "additionalProperties": false }, "ListConnectionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetConnectionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Connection" } }, "required": [ "data" ] }, "CreateConnectionSessionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionSession" } }, "required": [ "data" ] }, "UpdateConnectionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Connection" } }, "required": [ "data" ] }, "ReconnectConnectionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionSession" } }, "required": [ "data" ] }, "GetConnectionToolsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionTools" } }, "required": [ "data" ] }, "UpdateConnectionToolsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionTools" } }, "required": [ "data" ] }, "GetConnectionSessionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionSession" } }, "required": [ "data" ] }, "CancelConnectionSessionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionSession" } }, "required": [ "data" ] }, "SkillsSharing": { "type": "object", "properties": { "organization_access": { "type": "string", "enum": [ "read" ], "nullable": true }, "organization_user_accesses": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "read" ] }, "maxProperties": 2000 } }, "required": [ "organization_access", "organization_user_accesses" ], "additionalProperties": false }, "SkillsSharingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SkillsSharing" } }, "required": [ "data" ] }, "ConnectionsSharing": { "type": "object", "properties": { "organization_access": { "type": "string", "enum": [ "use" ], "nullable": true }, "organization_user_accesses": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "use" ] }, "maxProperties": 2000 } }, "required": [ "organization_access", "organization_user_accesses" ], "additionalProperties": false }, "ConnectionsSharingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionsSharing" } }, "required": [ "data" ] }, "AutomationTriggerWrite": { "type": "object", "properties": { "id": { "type": "string" }, "trigger_type": { "type": "string", "enum": [ "schedule", "integration" ] }, "schedule_frequency": { "type": "string", "enum": [ "15_minutely", "hourly", "daily" ] }, "schedule_interval": { "type": "integer", "minimum": 1, "maximum": 999 }, "schedule_anchor_time": { "type": "string" }, "schedule_days": { "type": "array", "items": { "type": "string" }, "maxItems": 7 }, "integration_trigger_key": { "type": "string" }, "inputs": { "type": "object", "additionalProperties": true } }, "additionalProperties": false }, "AutomationTrigger": { "type": "object", "properties": { "id": { "type": "string" }, "trigger_type": { "type": "string", "enum": [ "schedule", "integration" ] }, "schedule_frequency": { "type": "string", "enum": [ "15_minutely", "hourly", "daily" ] }, "schedule_interval": { "type": "integer", "minimum": 1, "maximum": 999 }, "schedule_anchor_time": { "type": "string" }, "schedule_days": { "type": "array", "items": { "type": "string" }, "maxItems": 7 }, "integration_trigger_key": { "type": "string" }, "inputs": { "type": "object", "additionalProperties": true }, "next_run_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string" } }, "required": [ "id", "trigger_type", "updated_at" ] }, "AutomationCreate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "minLength": 1 }, "prompt": { "type": "string" }, "catalog_model_id": { "type": "string", "nullable": true }, "response_channel": { "type": "string", "nullable": true }, "chat_context": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "enum": [ 1 ] }, "revision": { "type": "integer", "minimum": 0 }, "skill_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "connection_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } } }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationTriggerWrite" }, "minItems": 1, "maxItems": 100 } }, "required": [ "name", "prompt", "triggers", "description" ], "additionalProperties": false }, "AutomationUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "minLength": 1 }, "prompt": { "type": "string" }, "catalog_model_id": { "type": "string", "nullable": true }, "response_channel": { "type": "string", "nullable": true }, "chat_context": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "integer", "enum": [ 1 ] }, "revision": { "type": "integer", "minimum": 0 }, "skill_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "connection_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } } }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationTriggerWrite" }, "minItems": 1, "maxItems": 100 } }, "additionalProperties": false }, "Automation": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "prompt": { "type": "string" }, "catalog_model_id": { "type": "string", "nullable": true }, "response_channel": { "type": "string", "nullable": true }, "chat_context": { "type": "object", "additionalProperties": true }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationTrigger" } }, "id": { "type": "string" }, "enabled": { "type": "boolean" }, "owner_id": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "enabled", "owner_id", "updated_at" ] }, "Operation": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "type": "string" }, "resource_id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "successful", "failed", "needs_attention" ] }, "created_at": { "type": "string" }, "started_at": { "type": "string", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "result": { "type": "object", "additionalProperties": true, "nullable": true }, "error_code": { "type": "string", "nullable": true }, "web_url": { "type": "string", "nullable": true } }, "required": [ "id", "action", "resource_id", "status" ] }, "AutomationMutation": { "type": "object", "properties": { "automation": { "$ref": "#/components/schemas/Automation" }, "operation": { "$ref": "#/components/schemas/Operation" } }, "required": [ "automation" ] }, "AutomationRun": { "type": "object", "properties": { "id": { "type": "string" }, "automation_id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "successful", "failed", "needs_attention" ] }, "origin": { "type": "string" }, "skip_reason": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "started_at": { "type": "string", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "web_url": { "type": "string" } }, "required": [ "id", "automation_id", "status" ] }, "ListAutomationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Automation" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "CreateAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } }, "required": [ "data" ] }, "GetAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } }, "required": [ "data" ] }, "UpdateAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationMutation" } }, "required": [ "data" ] }, "DeletedResource": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ] }, "DeleteAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeletedResource" } }, "required": [ "data" ] }, "EnableAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ] }, "DisableAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Automation" } }, "required": [ "data" ] }, "RunAutomationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationRun" } }, "required": [ "data" ] }, "ListAutomationRunsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRun" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetAutomationRunResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationRun" } }, "required": [ "data" ] }, "GetOperationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ] }, "AutomationsSharing": { "type": "object", "properties": { "organization_access": { "type": "string", "enum": [ "read", "write", null ], "nullable": true }, "organization_user_accesses": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "read", "write" ] }, "maxProperties": 2000 } }, "required": [ "organization_access", "organization_user_accesses" ], "additionalProperties": false }, "AutomationTriggerCreate": { "type": "object", "properties": { "trigger_type": { "type": "string", "enum": [ "schedule", "integration" ] }, "schedule_frequency": { "type": "string", "enum": [ "15_minutely", "hourly", "daily" ] }, "schedule_interval": { "type": "integer", "minimum": 1, "maximum": 999 }, "schedule_anchor_time": { "type": "string" }, "schedule_days": { "type": "array", "items": { "type": "string" }, "maxItems": 7 }, "integration_trigger_key": { "type": "string" }, "inputs": { "type": "object", "additionalProperties": true } }, "required": [ "trigger_type" ], "additionalProperties": false }, "AutomationTriggerUpdate": { "type": "object", "properties": { "trigger_type": { "type": "string", "enum": [ "schedule", "integration" ] }, "schedule_frequency": { "type": "string", "enum": [ "15_minutely", "hourly", "daily" ] }, "schedule_interval": { "type": "integer", "minimum": 1, "maximum": 999 }, "schedule_anchor_time": { "type": "string" }, "schedule_days": { "type": "array", "items": { "type": "string" }, "maxItems": 7 }, "integration_trigger_key": { "type": "string" }, "inputs": { "type": "object", "additionalProperties": true } }, "additionalProperties": false }, "ListAutomationTriggersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationTrigger" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetAutomationTriggerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationTrigger" } }, "required": [ "data" ] }, "CreateAutomationTriggerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationMutation" } }, "required": [ "data" ] }, "UpdateAutomationTriggerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationMutation" } }, "required": [ "data" ] }, "DeleteAutomationTriggerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutomationMutation" } }, "required": [ "data" ] }, "Run": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "successful", "failed", "needs_attention" ] }, "conversation_id": { "type": "string" }, "outcome": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "started_at": { "type": "string", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "web_url": { "type": "string" } }, "required": [ "id", "status", "conversation_id", "web_url" ] }, "RunLog": { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string" }, "content": { "type": "string", "nullable": true }, "created_at": { "type": "string" } }, "required": [ "id", "role", "created_at" ] }, "SkillExecution": { "type": "object", "properties": { "input": { "type": "string", "maxLength": 500000 } }, "additionalProperties": false }, "ExecuteSkillResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Run" } }, "required": [ "data" ] }, "GetRunResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Run" } }, "required": [ "data" ] }, "ListRunLogsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RunLog" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "Member": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "member", "admin" ] }, "owner": { "type": "boolean" }, "suspended_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string" } }, "required": [ "id", "user_id", "name", "email", "role", "owner", "updated_at" ] }, "MemberUpdate": { "type": "object", "properties": { "role": { "type": "string", "enum": [ "member", "admin" ] } }, "required": [ "role" ], "additionalProperties": false }, "ListUsersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Member" } }, "required": [ "data" ] }, "UpdateUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Member" } }, "required": [ "data" ] }, "SuspendUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Member" } }, "required": [ "data" ] }, "ActivateUserResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Member" } }, "required": [ "data" ] }, "Invitation": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "member", "admin" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "email", "role", "created_at", "updated_at" ] }, "InvitationCreate": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^[^\\s,;@]+@[^\\s,;@]+$" }, "role": { "type": "string", "enum": [ "member", "admin" ] } }, "required": [ "email", "role" ], "additionalProperties": false }, "InvitationDelivery": { "type": "object", "properties": { "invitation": { "$ref": "#/components/schemas/Invitation" }, "operation": { "$ref": "#/components/schemas/Operation" } }, "required": [ "invitation", "operation" ] }, "ListInvitationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invitation" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetInvitationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Invitation" } }, "required": [ "data" ] }, "CreateInvitationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InvitationDelivery" } }, "required": [ "data" ] }, "ResendInvitationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InvitationDelivery" } }, "required": [ "data" ] }, "RevokeInvitationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeletedResource" } }, "required": [ "data" ] }, "Model": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "thinking_effort": { "type": "string", "nullable": true }, "context_window_tokens": { "type": "integer", "nullable": true }, "max_output_tokens": { "type": "integer", "nullable": true } }, "required": [ "id", "name" ] }, "ListModelsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Model" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetModelResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Model" } }, "required": [ "data" ] }, "ActivityEvent": { "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "occurred_at": { "type": "string", "nullable": false }, "ingested_at": { "type": "string", "nullable": false }, "event_type": { "type": "string", "nullable": false }, "actor_id": { "type": "string", "nullable": true }, "actor_kind": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "integration": { "type": "string", "nullable": true }, "tool": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "run_id": { "type": "string", "nullable": true }, "automation_id": { "type": "string", "nullable": true }, "conversation_id": { "type": "string", "nullable": true }, "payload": { "type": "object", "additionalProperties": true } }, "required": [ "id", "occurred_at", "ingested_at", "event_type" ] }, "ListActivityResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityEvent" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetActivityResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ActivityEvent" } }, "required": [ "data" ] }, "MarketplaceEditorial": { "type": "object", "properties": { "name": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "release_notes": { "type": "string" }, "example_prompts": { "type": "array", "items": { "type": "string" }, "maxItems": 50 }, "integration_slugs": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } }, "additionalProperties": false }, "MarketplaceListingCreate": { "type": "object", "properties": { "publisher_id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "release_notes": { "type": "string" }, "example_prompts": { "type": "array", "items": { "type": "string" }, "maxItems": 50 }, "integration_slugs": { "type": "array", "items": { "type": "string" }, "maxItems": 20 } }, "required": [ "publisher_id" ], "additionalProperties": false }, "MarketplaceListing": { "type": "object", "properties": { "id": { "type": "string" }, "publisher_id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "published", "unlisted", "withdrawn", "archived" ] }, "current_release_id": { "type": "string", "nullable": true }, "first_published_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "install_count": { "type": "integer" }, "installation_id": { "type": "string", "nullable": true }, "publisher": { "type": "object", "properties": { "id": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "avatar_url": { "type": "string", "nullable": true } }, "required": [ "id", "display_name", "slug", "kind" ] }, "release": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "category": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "nullable": true }, "thumbnail_url": { "type": "string", "nullable": true }, "version": { "type": "integer" }, "headline": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "cover_url": { "type": "string", "nullable": true }, "counts": { "type": "object", "properties": { "skills": { "type": "integer" }, "rules": { "type": "integer" }, "automations": { "type": "integer" }, "documents": { "type": "integer" } }, "required": [ "skills", "rules", "automations", "documents" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "kind": { "type": "string" } }, "required": [ "name", "description", "kind" ] } }, "example_prompts": { "type": "array", "items": { "type": "string" } }, "suggested_integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } }, "install": { "type": "object", "properties": { "personal": { "type": "boolean" }, "requires_admin": { "type": "boolean" } }, "required": [ "personal", "requires_admin" ] } }, "required": [ "id", "name", "summary", "kind", "category", "thumbnail_url", "version" ], "nullable": true } }, "required": [ "id", "publisher_id", "slug", "status", "updated_at" ] }, "MarketplaceRelease": { "type": "object", "properties": { "name": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "headline": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "release_notes": { "type": "string" }, "example_prompts": { "type": "array", "items": { "type": "string" }, "maxItems": 50 }, "integration_slugs": { "type": "array", "items": { "type": "string" }, "maxItems": 20 }, "id": { "type": "string" }, "listing_id": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "published" ] }, "version": { "type": "integer", "nullable": true }, "updated_at": { "type": "string" } }, "required": [ "id", "listing_id", "status", "name", "summary", "updated_at" ] }, "MarketplaceListingCreated": { "type": "object", "properties": { "listing": { "$ref": "#/components/schemas/MarketplaceListing" }, "release": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "listing", "release" ] }, "MarketplaceReleaseCreate": { "type": "object", "properties": { "listing_id": { "type": "string" } }, "required": [ "listing_id" ], "additionalProperties": false }, "MarketplaceWithdrawal": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "reason" ], "additionalProperties": false }, "MarketplaceValidation": { "type": "object", "properties": { "valid": { "type": "boolean" }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "listing_kind": { "type": "string" }, "content_digest": { "type": "string" } }, "required": [ "valid", "counts", "listing_kind", "content_digest" ] }, "ListMarketplaceListingsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceListing" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListing" } }, "required": [ "data" ] }, "CreateMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListingCreated" } }, "required": [ "data" ] }, "UnlistMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListing" } }, "required": [ "data" ] }, "RelistMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListing" } }, "required": [ "data" ] }, "ArchiveMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListing" } }, "required": [ "data" ] }, "WithdrawMarketplaceListingResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceListing" } }, "required": [ "data" ] }, "ListMarketplaceReleasesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "CreateMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "UpdateMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "DeleteMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeletedResource" } }, "required": [ "data" ] }, "ValidateMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceValidation" } }, "required": [ "data" ] }, "PublishMarketplaceReleaseResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "MarketplaceCategory": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "name", "slug" ] }, "MarketplacePublisher": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "name", "slug", "kind", "status" ] }, "MarketplaceSource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "name", "kind" ] }, "MarketplaceItem": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "position": { "type": "integer" }, "updated_at": { "type": "string" }, "triggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "trigger_type": { "type": "string" }, "frequency": { "type": "string", "nullable": true }, "interval": { "type": "integer", "nullable": true }, "anchor_time": { "type": "string", "nullable": true }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "maxItems": 7, "uniqueItems": true }, "integration_slug": { "type": "string", "nullable": true }, "trigger_slug": { "type": "string", "nullable": true }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "value_type": { "type": "string" }, "cardinality": { "type": "string" }, "binding_mode": { "type": "string" }, "required": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "key", "binding_mode" ] } } }, "required": [ "id", "trigger_type", "inputs" ] } } }, "required": [ "id", "kind", "name", "position", "updated_at" ] }, "MarketplaceItemCreate": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "skill", "automation", "rule", "knowledge" ] }, "source_id": { "type": "string" } }, "required": [ "kind", "source_id" ], "additionalProperties": false }, "MarketplaceItemUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "schedules": { "type": "array", "maxItems": 20, "items": { "type": "object", "properties": { "trigger_id": { "type": "string" }, "frequency": { "type": "string", "enum": [ "15_minutely", "hourly", "daily" ] }, "interval": { "type": "integer", "minimum": 1, "maximum": 999 }, "anchor_time": { "type": "string" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 6 }, "maxItems": 7, "uniqueItems": true } }, "required": [ "trigger_id", "frequency", "interval", "anchor_time", "weekdays" ], "additionalProperties": false } }, "trigger_inputs": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "trigger_id": { "type": "string" }, "input_id": { "type": "string" }, "binding_mode": { "type": "string", "enum": [ "fixed", "installer" ] }, "values": { "type": "array", "items": { "type": "string", "maxLength": 2000 }, "maxItems": 100 } }, "required": [ "trigger_id", "input_id", "binding_mode", "values" ], "additionalProperties": false } } }, "additionalProperties": false }, "MarketplaceItemOrder": { "type": "object", "properties": { "item_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "uniqueItems": true } }, "required": [ "item_ids" ], "additionalProperties": false }, "ListMarketplaceCategoriesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceCategory" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "ListMarketplacePublishersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplacePublisher" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "ListMarketplaceSourcesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceSource" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetMarketplacePublisherResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplacePublisher" } }, "required": [ "data" ] }, "ListMarketplaceItemsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceItem" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "AddMarketplaceItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "UpdateMarketplaceItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "RemoveMarketplaceItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "RefreshMarketplaceItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "ReorderMarketplaceItemsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "MarketplaceInstallation": { "type": "object", "properties": { "id": { "type": "string" }, "listing_id": { "type": "string" }, "release_id": { "type": "string" }, "scope": { "type": "string", "enum": [ "personal", "organization" ] }, "owner_id": { "type": "string", "nullable": true }, "steward_id": { "type": "string" }, "status": { "type": "string" }, "generation": { "type": "integer" }, "installed_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "listing_snapshot": { "$ref": "#/components/schemas/MarketplaceListing" }, "example_prompts": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "listing_id", "release_id", "scope", "status", "generation", "updated_at" ] }, "MarketplaceInstallationCreate": { "type": "object", "properties": { "listing_id": { "type": "string" }, "release_id": { "type": "string" }, "scope": { "type": "string", "enum": [ "personal", "organization" ] }, "steward_id": { "type": "string" } }, "required": [ "listing_id" ], "additionalProperties": false }, "MarketplaceInstallationUpdate": { "type": "object", "properties": { "release_id": { "type": "string" }, "digest": { "type": "string" }, "choices": { "type": "object", "maxProperties": 2000, "additionalProperties": { "type": "string", "enum": [ "keep", "replace", "add", "remove" ] } } }, "required": [ "release_id", "digest", "choices" ], "additionalProperties": false }, "MarketplaceInstallationRemove": { "type": "object", "properties": { "digest": { "type": "string" }, "choices": { "type": "object", "maxProperties": 1000, "additionalProperties": { "type": "string", "enum": [ "keep", "remove" ] } } }, "required": [ "digest", "choices" ], "additionalProperties": false }, "MarketplaceInstallationTransfer": { "type": "object", "properties": { "user_id": { "type": "string" } }, "required": [ "user_id" ], "additionalProperties": false }, "MarketplaceUpdatePreview": { "type": "object", "properties": { "digest": { "type": "string" }, "release_id": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "item_key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "change": { "type": "string" }, "modified": { "type": "boolean" }, "actions": { "type": "array", "items": { "type": "string" } }, "default_action": { "type": "string" } }, "required": [ "item_key", "name", "kind", "change", "modified", "actions", "default_action" ] } } }, "required": [ "digest", "release_id", "items" ] }, "MarketplaceRemovePreview": { "type": "object", "properties": { "digest": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "missing": { "type": "boolean" }, "modified": { "type": "boolean" }, "shared": { "type": "boolean" }, "can_remove": { "type": "boolean" }, "default_action": { "type": "string" } }, "required": [ "id", "name", "kind", "missing", "modified", "shared", "can_remove", "default_action" ] } } }, "required": [ "digest", "items" ] }, "ListMarketplaceInstallationsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetMarketplaceInstallationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "required": [ "data" ] }, "CreateMarketplaceInstallationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "required": [ "data" ] }, "UpdateMarketplaceInstallationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "required": [ "data" ] }, "RemoveMarketplaceInstallationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "required": [ "data" ] }, "TransferMarketplaceInstallationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceInstallation" } }, "required": [ "data" ] }, "PreviewMarketplaceInstallationUpdateResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceUpdatePreview" } }, "required": [ "data" ] }, "PreviewMarketplaceInstallationRemovalResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRemovePreview" } }, "required": [ "data" ] }, "MarketplaceArtworkUpload": { "type": "object", "properties": { "content": { "type": "string", "format": "byte", "maxLength": 6990508 } }, "required": [ "content" ], "additionalProperties": false }, "UploadMarketplaceArtworkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ] }, "DeleteMarketplaceArtworkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceRelease" } }, "required": [ "data" ] }, "MarketplaceAnalytics": { "type": "object", "properties": { "listing_id": { "type": "string" }, "from": { "type": "string" }, "through": { "type": "string" }, "totals": { "type": "object", "additionalProperties": { "type": "integer" } }, "series": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } } }, "required": [ "date", "counts" ] } }, "active_installations": { "type": "integer" }, "marketplace_installs": { "type": "integer" }, "legacy_installs": { "type": "integer" }, "refreshed_at": { "type": "string", "nullable": true } }, "required": [ "listing_id", "from", "through", "totals", "series" ] }, "GetMarketplaceAnalyticsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceAnalytics" } }, "required": [ "data" ] }, "GetMarketplaceItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceItem" } }, "required": [ "data" ] }, "ConnectionSyncWrite": { "type": "object", "properties": { "version": { "type": "string" }, "streams": { "type": "object", "maxProperties": 200, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "interval_seconds": { "type": "integer", "minimum": 1 }, "history_mode": { "type": "string", "enum": [ "from_now", "lookback", "start_at", "all_available" ] }, "lookback_seconds": { "type": "integer", "minimum": 1 }, "start_date": { "type": "string" } }, "additionalProperties": false } }, "time_zone": { "type": "string" } }, "required": [ "version", "streams" ], "additionalProperties": false }, "ConnectionSync": { "type": "object", "properties": { "version": { "type": "string" }, "streams": { "type": "object", "maxProperties": 200, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "interval_seconds": { "type": "integer", "minimum": 1 }, "history_mode": { "type": "string", "enum": [ "from_now", "lookback", "start_at", "all_available" ] }, "lookback_seconds": { "type": "integer", "minimum": 1 }, "start_date": { "type": "string" } }, "additionalProperties": false } }, "stream_contracts": { "type": "object", "additionalProperties": true }, "configured": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "time_zone": { "type": "string" } }, "required": [ "version", "streams", "stream_contracts", "configured", "time_zone" ] }, "GetConnectionSyncResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConnectionSync" } }, "required": [ "data" ] }, "UpdateConnectionSyncResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ] }, "DisconnectConnectionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ] }, "ActivityArchive": { "type": "object", "additionalProperties": false, "required": [ "id", "month", "status", "hydration" ], "properties": { "id": { "type": "string" }, "month": { "type": "string", "format": "date" }, "status": { "type": "string", "enum": [ "archived" ] }, "hydration": { "type": "object", "nullable": true, "additionalProperties": false, "required": [ "status", "expires_at", "expired" ], "properties": { "status": { "type": "string", "enum": [ "pending", "processing", "ready", "failed" ] }, "expires_at": { "type": "string", "format": "date-time", "nullable": true }, "expired": { "type": "boolean" } } } } }, "ListActivityArchivesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityArchive" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ] } }, "required": [ "data", "page" ] }, "GetActivityArchiveResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ActivityArchive" } } }, "ActivityDelivery": { "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "occurred_at": { "type": "string", "nullable": false }, "ingested_at": { "type": "string", "nullable": false }, "event_type": { "type": "string", "nullable": false }, "actor_id": { "type": "string", "nullable": true }, "actor_kind": { "type": "string", "nullable": true }, "actor_name": { "type": "string", "nullable": true }, "origin": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "integration": { "type": "string", "nullable": true }, "tool": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "run_id": { "type": "string", "nullable": true }, "automation_id": { "type": "string", "nullable": true }, "conversation_id": { "type": "string", "nullable": true }, "payload": { "type": "object", "additionalProperties": true }, "delivery_id": { "type": "string", "format": "uuid" } }, "required": [ "id", "occurred_at", "ingested_at", "event_type", "delivery_id" ] }, "TailActivityResponse": { "type": "object", "required": [ "data", "page" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityDelivery" } }, "page": { "type": "object", "required": [ "next_cursor", "has_more" ], "properties": { "next_cursor": { "type": "string" }, "has_more": { "type": "boolean" } } } } }, "LibraryItem": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string", "nullable": true }, "file_type": { "type": "string", "nullable": true }, "content_type": { "type": "string" }, "published_at": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "source": { "type": "string" }, "folder_id": { "type": "string", "nullable": true }, "byte_size": { "type": "integer", "nullable": true }, "outdated": { "type": "boolean" }, "thumbnail_url": { "type": "string", "nullable": true } }, "required": [ "id", "name", "summary", "file_type", "content_type", "published_at", "created_at", "updated_at", "source", "folder_id", "byte_size", "outdated" ], "additionalProperties": false }, "LibraryFolder": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parent_id": { "type": "string", "nullable": true }, "item_count": { "type": "integer" } }, "required": [ "id", "name", "parent_id", "item_count" ], "additionalProperties": false }, "LibraryContent": { "type": "object", "properties": { "id": { "type": "string" }, "download_url": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true } }, "required": [ "id", "download_url", "content" ], "additionalProperties": false }, "LibraryShareLink": { "type": "object", "properties": { "url": { "type": "string" }, "expires_at": { "type": "string" } }, "required": [ "url", "expires_at" ], "additionalProperties": false }, "LibraryShareInput": { "type": "object", "properties": { "expires_in": { "type": "string" } }, "required": [ "expires_in" ], "additionalProperties": false }, "ListLibraryItemsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryItem" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false } }, "required": [ "data", "page" ], "additionalProperties": false }, "GetLibraryItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LibraryItem" } }, "required": [ "data" ], "additionalProperties": false }, "GetLibraryItemContentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LibraryContent" } }, "required": [ "data" ], "additionalProperties": false }, "DeleteLibraryItemResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deletion" } }, "required": [ "data" ], "additionalProperties": false }, "CreateLibraryShareLinkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LibraryShareLink" } }, "required": [ "data" ], "additionalProperties": false }, "ListLibraryFoldersResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LibraryFolder" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false } }, "required": [ "data", "page" ], "additionalProperties": false }, "AgentRunInput": { "type": "object", "additionalProperties": false, "required": [ "threadId", "runId", "messages", "tools", "context", "forwardedProps" ], "properties": { "threadId": { "type": "string", "minLength": 1, "maxLength": 255 }, "runId": { "type": "string", "minLength": 1, "maxLength": 255 }, "parentRunId": { "type": "string", "nullable": true }, "messages": { "type": "array", "maxItems": 1000, "items": { "type": "object", "additionalProperties": true } }, "tools": { "type": "array", "maxItems": 0, "items": {} }, "context": { "type": "array", "maxItems": 0, "items": {} }, "state": { "type": "object", "additionalProperties": false, "nullable": true }, "forwardedProps": { "type": "object", "additionalProperties": false, "properties": { "clientName": { "type": "string" }, "clientVersion": { "type": "string" } } }, "resume": { "type": "array", "maxItems": 100, "items": { "type": "object", "additionalProperties": false, "required": [ "interruptId", "status" ], "properties": { "interruptId": { "type": "string" }, "status": { "type": "string", "enum": [ "resolved", "cancelled" ] }, "payload": {}, "metadata": { "type": "object", "additionalProperties": true } } } } } }, "AgentRunAdmission": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "successful", "failed", "needs_attention" ] }, "conversation_id": { "type": "string" }, "outcome": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "started_at": { "type": "string", "nullable": true }, "finished_at": { "type": "string", "nullable": true }, "web_url": { "type": "string" }, "events_path": { "type": "string" } }, "required": [ "id", "status", "conversation_id", "web_url", "events_path" ] }, "CreateAgentRunResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AgentRunAdmission" } }, "required": [ "data" ], "additionalProperties": false }, "CommunityAuthor": { "type": "object", "properties": { "name": { "type": "string" }, "avatar_url": { "type": "string", "nullable": true } }, "required": [ "name", "avatar_url" ], "additionalProperties": false }, "CommunityReactions": { "type": "object", "properties": { "total": { "type": "integer" }, "counts": { "type": "object", "additionalProperties": { "type": "integer" } }, "mine": { "type": "string", "nullable": true } }, "required": [ "total", "counts", "mine" ], "additionalProperties": false }, "CommunitySpace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "emoji": { "type": "string", "nullable": true }, "custom_emoji_url": { "type": "string", "nullable": true }, "cover_image_url": { "type": "string", "nullable": true }, "group": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true } }, "required": [ "id", "name" ], "additionalProperties": false, "nullable": true }, "is_member": { "type": "boolean" }, "is_private": { "type": "boolean" }, "can_view": { "type": "boolean" }, "can_post": { "type": "boolean" }, "can_join": { "type": "boolean" } }, "required": [ "id", "name", "emoji", "custom_emoji_url", "cover_image_url", "group", "is_member", "is_private", "can_view", "can_post", "can_join" ], "additionalProperties": false }, "CommunityPost": { "type": "object", "properties": { "id": { "type": "string" }, "space_id": { "type": "string" }, "title": { "type": "string", "nullable": true }, "excerpt": { "type": "string" }, "author": { "$ref": "#/components/schemas/CommunityAuthor" }, "created_at": { "type": "string", "nullable": true }, "comment_count": { "type": "integer" }, "pinned": { "type": "boolean" }, "reactions": { "$ref": "#/components/schemas/CommunityReactions" } }, "required": [ "id", "space_id", "title", "excerpt", "author", "created_at", "comment_count", "pinned", "reactions" ], "additionalProperties": false }, "CommunityPostDetail": { "type": "object", "properties": { "id": { "type": "string" }, "space_id": { "type": "string" }, "title": { "type": "string", "nullable": true }, "excerpt": { "type": "string" }, "author": { "$ref": "#/components/schemas/CommunityAuthor" }, "created_at": { "type": "string", "nullable": true }, "comment_count": { "type": "integer" }, "pinned": { "type": "boolean" }, "reactions": { "$ref": "#/components/schemas/CommunityReactions" }, "body": { "type": "string" }, "comments_open": { "type": "boolean" }, "can_react": { "type": "boolean" }, "participation_allowed": { "type": "boolean" } }, "required": [ "id", "space_id", "title", "excerpt", "author", "created_at", "comment_count", "pinned", "reactions", "body", "comments_open", "can_react" ], "additionalProperties": false }, "CommunityComment": { "type": "object", "properties": { "id": { "type": "string" }, "author": { "$ref": "#/components/schemas/CommunityAuthor" }, "created_at": { "type": "string", "nullable": true }, "body_text": { "type": "string" }, "replies_count": { "type": "integer" }, "liked": { "type": "boolean" }, "likes_count": { "type": "integer" } }, "required": [ "id", "author", "created_at", "body_text", "replies_count", "liked", "likes_count" ], "additionalProperties": false }, "CommunityCommentInput": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "parent_comment_id": { "type": "string", "nullable": true } }, "required": [ "body" ], "additionalProperties": false }, "CommunityReactionInput": { "type": "object", "properties": { "reaction_type": { "type": "string", "enum": [ "like", "celebrate", "love", "support", "insightful", "funny" ] } }, "required": [ "reaction_type" ], "additionalProperties": false }, "ListCommunitySpacesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommunitySpace" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data", "page", "meta" ], "additionalProperties": false }, "JoinCommunitySpaceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ], "additionalProperties": false }, "ListCommunityPostsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommunityPost" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data", "page", "meta" ], "additionalProperties": false }, "GetCommunityPostResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CommunityPostDetail" } }, "required": [ "data" ], "additionalProperties": false }, "ListCommunityCommentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommunityComment" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data", "page", "meta" ], "additionalProperties": false }, "CreateCommunityCommentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ], "additionalProperties": false }, "ListCommunityRepliesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommunityComment" } }, "page": { "type": "object", "properties": { "next_cursor": { "type": "string", "nullable": true } }, "required": [ "next_cursor" ], "additionalProperties": false }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "data", "page", "meta" ], "additionalProperties": false }, "SetCommunityReactionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ], "additionalProperties": false }, "RemoveCommunityReactionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" } }, "required": [ "data" ], "additionalProperties": false }, "MarketplaceStorefront": { "type": "object", "properties": { "featured": { "type": "object", "properties": { "id": { "type": "string" }, "publisher_id": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "published", "unlisted", "withdrawn", "archived" ] }, "current_release_id": { "type": "string", "nullable": true }, "first_published_at": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "install_count": { "type": "integer" }, "installation_id": { "type": "string", "nullable": true }, "publisher": { "type": "object", "properties": { "id": { "type": "string" }, "display_name": { "type": "string" }, "slug": { "type": "string" }, "kind": { "type": "string" }, "avatar_url": { "type": "string", "nullable": true } }, "required": [ "id", "display_name", "slug", "kind" ] }, "release": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string", "nullable": true }, "kind": { "type": "string" }, "category": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "nullable": true }, "thumbnail_url": { "type": "string", "nullable": true }, "version": { "type": "integer" }, "headline": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "cover_url": { "type": "string", "nullable": true }, "counts": { "type": "object", "properties": { "skills": { "type": "integer" }, "rules": { "type": "integer" }, "automations": { "type": "integer" }, "documents": { "type": "integer" } }, "required": [ "skills", "rules", "automations", "documents" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "kind": { "type": "string" } }, "required": [ "name", "description", "kind" ] } }, "example_prompts": { "type": "array", "items": { "type": "string" } }, "suggested_integrations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "name", "slug" ] } }, "install": { "type": "object", "properties": { "personal": { "type": "boolean" }, "requires_admin": { "type": "boolean" } }, "required": [ "personal", "requires_admin" ] } }, "required": [ "id", "name", "summary", "kind", "category", "thumbnail_url", "version" ], "nullable": true } }, "required": [ "id", "publisher_id", "slug", "status", "updated_at" ], "nullable": true }, "popular_skills": { "type": "array", "items": { "$ref": "#/components/schemas/MarketplaceListing" } }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "artwork_url": { "type": "string", "nullable": true } }, "required": [ "id", "name", "slug", "description", "artwork_url" ] } } }, "required": [ "featured", "popular_skills", "collections" ] }, "GetMarketplaceStorefrontResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MarketplaceStorefront" } }, "required": [ "data" ] }, "GetCommunitySpaceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CommunitySpace" } }, "required": [ "data" ] }, "NotificationTokenInput": { "type": "object", "additionalProperties": false, "required": [ "token" ], "properties": { "token": { "type": "string", "minLength": 1, "maxLength": 200 } } }, "NotificationToken": { "type": "object", "required": [ "token", "platform" ], "properties": { "token": { "type": "string" }, "platform": { "type": "string", "enum": [ "iOS" ] } } }, "RegisterNotificationTokenResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationToken" } }, "required": [ "data" ] }, "UnregisterNotificationTokenResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deletion" } }, "required": [ "data" ] } }, "responses": { "BadRequest": { "description": "Invalid request parameters, body, or idempotency key.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Unauthorized": { "description": "Missing, expired, revoked, or invalid bearer credential.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "about:blank", "title": "Unauthenticated", "status": 401, "code": "unauthenticated", "detail": "A valid bearer credential is required", "request_id": "0b7238c5-a883-4ed0-8613-31f531e50f40" } } }, "headers": { "WWW-Authenticate": { "description": "Bearer authentication challenge.", "schema": { "type": "string" }, "example": "Bearer" } } }, "Forbidden": { "description": "Insufficient scope or resource permissions.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "NotFound": { "description": "Resource not found or not visible to this credential.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "Conflict": { "description": "Resource state or idempotency conflict.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "CursorExpired": { "description": "Activity tail cursor is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "PreconditionFailed": { "description": "Resource or content version has changed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "ContentTooLarge": { "description": "Request body exceeds the operation limit.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "UnsupportedMediaType": { "description": "Request body must use application/json.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "UnprocessableContent": { "description": "Request failed domain validation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "PreconditionRequired": { "description": "Required If-Match header is missing.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" }, "example": { "type": "about:blank", "title": "Precondition required", "status": 428, "code": "precondition_required", "detail": "Supply the resource ETag in If-Match", "request_id": "0b7238c5-a883-4ed0-8613-31f531e50f40" } } } }, "TooManyRequests": { "description": "Rate limit exceeded; wait Retry-After seconds.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } }, "headers": { "Retry-After": { "description": "Delay in seconds before retrying.", "schema": { "type": "integer" }, "example": 60 } } }, "ServiceUnavailable": { "description": "A required service is temporarily unavailable.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } }, "headers": { "ETag": { "description": "Opaque resource version. Send this value unchanged as If-Match on conditional mutations.", "schema": { "type": "string" } }, "Location": { "description": "Relative URL of the admitted run, connection session, or asynchronous operation.", "schema": { "type": "string" } } } }, "tags": [ { "name": "Identity", "description": "Inspect the user, organization, and scopes associated with your bearer credential. Use this endpoint to confirm which account and organization your integration is acting on." }, { "name": "Organizations", "description": "Read metadata for the organization bound to your credential. The collection contains that organization only. To work with another organization, authorize it separately and use its credential." }, { "name": "Skills", "description": "Create reusable prompts, manage their content, and share them with other members of your organization. Fork an accessible skill to make your own copy, or restore a fork from its source.\n\nRun a skill with optional input to start an asynchronous execution. Follow the returned run to inspect its status and logs." }, { "name": "Knowledge", "description": "Browse namespaces and documents, search their content, and explore document history and links. Collection endpoints return metadata; fetch a document or version to read its content.\n\nContent updates require both the document ETag and its content version. Personal tokens can write only to the user’s own namespace." }, { "name": "Personal tokens", "description": "Create and revoke credentials for unattended integrations, and inspect existing token metadata. Each token is bound to one organization and has its own scopes and expiry.\n\nIssuance requires recent first-party CLI OAuth authentication. The secret is returned only when the token is created; it cannot be recovered by replaying the request." }, { "name": "Integrations", "description": "Discover available integration providers and inspect their tools, triggers, and input schemas. Enable providers for your organization before creating connections. Provider availability and management actions remain subject to your account permissions." }, { "name": "Connections", "description": "Connect external accounts, inspect their tools, and manage sharing and sync configuration. Creating or reconnecting an account returns a connection session with an authorization URL.\n\nFollow the session to check connection progress. Disconnection and sync changes return asynchronous operations that can be polled for completion." }, { "name": "Automations", "description": "Create workflows with prompts and scheduled or integration-based triggers. Manage their definitions, sharing, and enabled state, or start a manual run.\n\nTrigger mutations use the parent automation’s ETag. Changes that require asynchronous activation return an operation; run endpoints expose execution status and logs." }, { "name": "Operations", "description": "Track background work accepted by mutation endpoints. Poll the returned operation until it reaches a terminal state.\n\nOnly `successful` confirms completion. Inspect `error_code` when an operation fails. A `needs_attention` outcome requires investigation before repeating the mutation." }, { "name": "Runs", "description": "Inspect an execution started through the API and retrieve its conversation logs. Access follows the underlying skill conversation or automation permissions.\n\nLogs are paginated and may change while a run is active. Poll the run to determine when execution finishes." }, { "name": "Members", "description": "List organization members and inspect their roles and access status. Administrators with the required scope can change roles, suspend members, or reactivate them.\n\nMember IDs identify organization memberships; the separate `user_id` identifies the user account. Conditional changes require the member’s current ETag." }, { "name": "Invitations", "description": "Invite people to your organization, inspect pending invitations, resend delivery, or revoke an invitation. Creation and resending return an invitation together with a delivery operation.\n\nFollow that operation to confirm delivery processing. Resending and revoking require the invitation’s current ETag." }, { "name": "Models", "description": "Discover the models available to your account and inspect their reasoning settings and context and output limits. Use a returned model ID when configuring an automation that accepts a model selection." }, { "name": "Activity", "description": "Browse recorded activity and filter events by time, actor, type, status, or origin. Fetch an event separately to inspect its payload.\n\nTail follows newly published deliveries using a resumable cursor. Deduplicate deliveries by `delivery_id`. Archive endpoints expose older activity and allow authorized users to request hydration." }, { "name": "Marketplace", "description": "Discover published listings, categories, and publishers, then install resources into your organization. Publishers can prepare draft releases, manage their items and artwork, validate them, and publish.\n\nPreview an installation update or removal before submitting its digest and choices. Draft item mutations use the parent release’s ETag." }, { "name": "Library", "description": "Browse your accessible files and folders, inspect file metadata, and retrieve content or temporary download URLs. Small Markdown and plain-text files can be returned inline.\n\nCreate expiring share links when sharing is permitted. Deleting an item requires its current ETag." }, { "name": "Agent runs", "description": "Start an agent execution with the supported AG-UI input and follow its server-sent event stream. Admission returns the run and an `events_path`; use `Last-Event-ID` to resume event delivery.\n\nClosing the stream does not cancel execution. Personal tokens start unattended runs and cannot resolve interactive approvals or questions." }, { "name": "Community", "description": "Browse community spaces, discussions, comments, and replies. Participation actions include joining spaces, commenting, and reacting, subject to the organization’s plan and current permissions.\n\nWrites return asynchronous operations. Reaction changes require the discussion’s current ETag. Paginated discussions may repeat pinned posts, so deduplicate by ID." }, { "name": "Notifications", "description": "Register or remove an iOS APNs device token for agent-run notifications. These endpoints require the iOS-only `notifications:write` scope and are unavailable to CLI credentials and personal tokens.\n\nA device token belongs to the user who most recently registered it." } ] }