{ "openapi": "3.0.3", "info": { "title": "Parkes Marketplace API", "version": "1.0.0", "description": "Manage publisher listings, draft releases, items, artwork, and publication. Uses the same organization-scoped bearer credentials as the REST API. Customer browsing and installations remain under /rest/v1/marketplace.\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": { "/marketplace/v1/listings": { "get": { "operationId": "manageListMarketplaceListings", "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/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": "List listings managed by the authenticated member in the token’s organization, including unpublished drafts. Uses marketplace:read and current publisher permissions.", "security": [ { "oauth": [ "marketplace:read" ] }, { "bearer": [] } ], "x-required-scopes": [ [ "marketplace:read" ] ], "tags": [ "Listings" ], "summary": "List your 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": [ "Listings" ], "summary": "Create listing" } }, "/marketplace/v1/listings/{id}": { "get": { "operationId": "manageGetMarketplaceListing", "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": [ "Listings" ], "summary": "Get listing" } }, "/marketplace/v1/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": [ "Listings" ], "summary": "Unlist listing" } }, "/marketplace/v1/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": [ "Listings" ], "summary": "Relist listing" } }, "/marketplace/v1/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": [ "Listings" ], "summary": "Archive listing" } }, "/marketplace/v1/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": [ "Listings" ], "summary": "Withdraw listing" } }, "/marketplace/v1/listings/{listing_id}/releases": { "get": { "operationId": "manageListMarketplaceReleases", "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": [ "Listings" ], "summary": "List releases" } }, "/marketplace/v1/releases/{id}": { "get": { "operationId": "manageGetMarketplaceRelease", "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": [ "Releases" ], "summary": "Get 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": [ "Releases" ], "summary": "Update 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": [ "Releases" ], "summary": "Delete release" } }, "/marketplace/v1/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": [ "Releases" ], "summary": "Create release" } }, "/marketplace/v1/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": [ "Releases" ], "summary": "Validate release" } }, "/marketplace/v1/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": [ "Releases" ], "summary": "Publish release" } }, "/marketplace/v1/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": [ "Publishing sources" ], "summary": "List sources" } }, "/marketplace/v1/releases/{release_id}/items": { "get": { "operationId": "manageListMarketplaceItems", "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": [ "Release items" ], "summary": "List 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": [ "Release items" ], "summary": "Add item" } }, "/marketplace/v1/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": [ "Release items" ], "summary": "Update 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": [ "Release items" ], "summary": "Remove item" }, "get": { "operationId": "manageGetMarketplaceItem", "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": [ "Release items" ], "summary": "Get item" } }, "/marketplace/v1/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": [ "Release items" ], "summary": "Refresh item" } }, "/marketplace/v1/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": [ "Release items" ], "summary": "Reorder items" } }, "/marketplace/v1/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": [ "Artwork" ], "summary": "Upload 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": [ "Artwork" ], "summary": "Delete artwork" } }, "/marketplace/v1/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": [ "Listings" ], "summary": "Get analytics" } } }, "tags": [ { "name": "Listings", "description": "Manage your publisher listings, inspect analytics, and control visibility. Listing creation creates an initial draft release. Existing publisher ownership and organization permissions apply." }, { "name": "Releases", "description": "Create and edit draft releases, validate their contents, and publish. Read a release to obtain its current ETag before changing it. Published releases remain immutable." }, { "name": "Release items", "description": "Add source content to a draft release and manage its snapshots, ordering, schedules, and trigger inputs. Conditional writes use the parent release ETag." }, { "name": "Artwork", "description": "Upload or remove draft release cover and thumbnail images. Send base64-encoded image content and the parent release ETag." }, { "name": "Publishing sources", "description": "Find organization content you are allowed to include in a marketplace release. Publishing access and the marketplace:write scope are required." } ], "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." }, "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" ] }, "DeletedResource": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ] }, "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" ] }, "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 }, "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" ] }, "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" ] }, "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" ] } }, "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" } } } }, "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 } } } }, "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" } } } } }