openapi: 3.0.0 info: version: 0.0.2 title: Superhuman Docs Admin Account Packs API license: name: Superhuman Developer Terms url: https://docs.superhuman.com/trust/developer description: "# Introduction\n\nThe Superhuman Docs Admin API is a RESTful API that allows programmatic access to administrative reports & capabilities within Superhuman Docs (formerly Coda).\n\nAccess to the Admin API is limited to enterprise organizations.\nOnly organization admins can use the Admin API for resources related to their organization.\n\nAs we update and release newer versions of the API, we reserve the right to remove\nolder APIs and functionality with a 3-month deprecation notice. We will post about such changes as well as announce\nnew features in the [Developers Central](https://connect.superhuman.com/c/developers-central) section of our Community,\nand update the [API updates](https://docs.superhuman.com/api-updates) doc.\n\n# Using the Admin API\n\nThe Superhuman Docs Admin REST API is designed to be straightforward to use. You can use the language and platform of your choice\nto make requests. To get a feel for the API, you can also use a tool like [Postman](https://www.getpostman.com/) or\n[Insomnia](https://insomnia.rest/).\n\n## API Endpoint\n\nThis API uses a base path of `https://docs.superhuman.com/apis/admin/v1`.\n\n## Object Hierarchy\n\n### Organizations\n\nEnterprise customers have access to the Organization, an object that contains policy, rules, and audit events\nfor a set of workspaces and one or more domains. Users accessing Superhuman Docs via an Organization-registered domain are\nsubject to that Organization's policies including allowed forms of authentication,\ndoc & Pack sharing restrictions, etc.\n\n### Workspaces\n\nA workspace is your home base for all things Superhuman Docs. It will store your documents in an organized way, and you'll invite\nmembers into the workspace to help you get the job done. A workspace can be free or paid (depending on your plan),\nand as the workspace's Doc Maker or Doc Maker (Admin), you'll be able to dictate the rules for how it works.\n\n[Learn more about Workspaces in our help center](https://help.coda.io/hc/en-us/articles/39555775119117-Create-and-manage-your-Coda-workspace).\n\n### Folders\n\nWe use folders to keep docs organized in the workspace (think departments, teams, and projects). Your docs are\nwhere the true work gets done with all of your tables, text, and app-like solutions. Folders contain docs within\nthe workspace.\n\n[Learn more about Folders in our help center](https://help.coda.io/hc/en-us/articles/39555852126605-Create-and-share-folders).\n\n### Docs\n\nDocuments are foundational, top-level collaborative projects that contain pages.\n\n### Pack configurations\n\nPack configurations are the settings that define how a Pack may be used within an organization.\n\n### Pack configuration permissions\n\nPack configuration permissions are the settings that define which principals may use a Pack configuration.\n\n### Pack requests\n\nWhen Pack configurations are turned on inside an organization. Pack requests are requests to use a Pack submitted by\nusers in the organization.\n\n### Pages\n\nIndividual pages within a doc offer canvases containing rich text, tables, controls, and other objects.\n\n## Audit events\n\nAudit events contain records of user login/logout activities and other operations performed within a Superhuman Docs organization.\nAudit events are critical to an enterprise's Security Monitoring efforts. It enables Security professionals to proactively\nanalyze the audit events for any suspicious behavior within a Superhuman Docs organization and help them in forensic investigations\nin case of a security breach. Audit events also enable administrators to write their own applications to understand their\nusers' usage of Superhuman Docs.\n\n### Audit event actions\n\nThe following entity types and actions are audited.\n\n| Entity Type | Action Name | Description |\n| ----------- | ----------- | ----------- |\n| agentInstance | AcceptCustomAgentInvitation | Accept an invitation to access a custom agent |\n| agentInstance | AgentScheduleTriggerFired | A scheduled agent trigger fired |\n| agentInstance | CreateAgentInstance | Create a new agent instance |\n| agentInstance | CreateCustomAgentInvitation | Send an invitation to share a custom agent |\n| agentInstance | DeclineCustomAgentInvitation | Decline an invitation to access a custom agent |\n| agentInstance | DeleteAgentInstance | Delete an agent instance |\n| agentInstance | DeleteCustomAgentInvitation | Revoke a pending invitation to a custom agent |\n| agentInstance | StartAgentChat | Start a new agent chat session |\n| agentInstance | UpdateAgentInstance | Update an agent instance |\n| agentInstance | UpdateAgentInstanceSharing | Update sharing permissions on an agent instance |\n| agentToolCall | ApproveAgentToolCall | Approve a tool call during an agent instance session |\n| agentToolCall | ExecuteAgentToolCall | Execute a tool call during an agent instance session |\n| agentToolCall | IgnoreAgentToolCall | Ignore a tool call during an agent instance session |\n| agentToolCall | RejectAgentToolCall | Reject a tool call during an agent instance session |\n| apiToken | DeleteApiToken | Delete an API token |\n| apiToken | GenerateApiToken | Generate an API token |\n| billingAccount | AddBillingGroup | Add a billing group to a billing account |\n| billingAccount | AddBillingGroupAdmin | Assign a billing group admin |\n| billingAccount | DeleteBillingGroup | Delete a billing group from a billing account |\n| billingAccount | RemoveBillingGroupAdmin | Remove a billing group admin |\n| billingAccount | UpdateBillingAccountSettings | Update settings for a billing account |\n| brainQuery | BrainStructuredQuery | Query Coda Brain for structured data |\n| brainQuery | BrainUnstructuredQuery | Query Coda Brain for unstructured data |\n| doc | AddDocPack | Install a Pack within a doc |\n| doc | CopyDoc | Copy a doc to a new location |\n| doc | CopyPages | Copy pages and sub pages within a doc to a new location |\n| doc | CopyTemplate | Copy template to an existing doc |\n| doc | CreateDoc | Create a new doc |\n| doc | DeleteAllReferencingSyncPageTunnels | Delete all sync page tunnels referencing a doc |\n| doc | DeleteDoc | Delete a doc |\n| doc | DeleteDocPack | Remove usage of a Pack from a doc |\n| doc | EditDoc | Edit a doc |\n| doc | ExportDocContent | Export doc content |\n| doc | MoveDoc | Move a doc to a different folder |\n| doc | OpenDoc | Opening a doc for reading, commenting or editing. |\n| doc | ReviveDoc | Revive a deleted doc |\n| doc | SubmitForm | Submit through a form |\n| doc | UpdateDocPermissions | Update sharing permissions on a doc |\n| docPackConnection | CreateExternalConnection | Create a new Pack connection |\n| docPackConnection | DeleteExternalConnection | Delete a Pack connection |\n| docPackConnection | UpdateExternalConnection | Update a Pack connection |\n| folder | CreateFolder | Create a new folder |\n| folder | DeleteFolder | Delete a folder |\n| folder | MoveFolder | Move a folder to a different parent |\n| folder | UpdateFolderMembership | Update membership on a folder |\n| folder | UpdateFolderPermissions | Update sharing permissions on a folder |\n| folder | UpdateFolderSettings | Update folder settings |\n| group | CreateGroup | Create a new group |\n| group | DeleteGroup | Delete a group |\n| group | UpdateGroup | Update group properties |\n| import | CompleteImport | Complete an import |\n| import | FailImport | Fail an import |\n| import | OnboardItem | Onboard a single source item during an import |\n| import | StartImport | Start an import |\n| importPreference | AddImportPreference | Add an import preference for an importer |\n| importPreference | DeleteImportPreference | Delete an import preference for an importer |\n| importPreference | UpdateImportPreference | Update an import preference for an importer |\n| ingestion | CreateIngestion | Create a new Coda Brain ingestion |\n| ingestion | CreateIngestionPermissions | Create Coda Brain ingestion permissions |\n| ingestion | DeleteIngestion | Delete a Coda Brain ingestion |\n| ingestion | DeleteIngestionPermissions | Delete Coda Brain ingestion permissions |\n| ingestion | UpdateIngestion | Update a Coda Brain ingestion |\n| legalHold | CreateLegalHold | Create a new legal hold |\n| legalHold | DeleteLegalHold | Delete a legal hold |\n| legalHold | UpdateLegalHold | Update legal hold |\n| legalHoldExport | CreateLegalHoldExport | Create a new legal hold export |\n| legalHoldExport | DeleteLegalHoldExport | Delete a legal hold export |\n| organization | AddBlockedDomains | Add domains to the blocked domains list |\n| organization | AddTrustedDomains | Add domains to the trusted domains list |\n| organization | ClaimDocOwnership | Claim ownership of a doc after the owner is deactivated |\n| organization | OrganizationPackAccessRequestBlocked | A user attempted to request Pack access while the organization administrator has disabled Pack access requests |\n| organization | OrganizationPackAccessRequested | A user requested access to a Pack |\n| organization | RemoveBlockedDomains | Remove domains from the blocked domains list |\n| organization | RemoveTrustedDomains | Remove domains from the trusted domains list |\n| organization | TransferDocs | Transfer docs from one user to another |\n| organization | UpdateOrganizationSettings | Update organization settings |\n| organization | UpdateOrganizationUserActivation | Update a user's activation status in an organization |\n| organization | UpdateOrganizationUserRole | Add or remove user from organization roles |\n| organization | UpdateWorkspaceAiControls | Update workspace AI controls |\n| pack | AddPackConfigurationPermission | Add a Pack configuration permission |\n| pack | AllowPackAccessRequest | A user was granted access to a Pack |\n| pack | AutoApprovePack | A Pack was auto-approved upon creation per the organization policy |\n| pack | CancelPackReview | Cancel a pending Pack review |\n| pack | CreatePack | Create a new Pack |\n| pack | CreatePackConfiguration | Create a new Pack configuration |\n| pack | CreatePackInvitation | Create a Pack invitation |\n| pack | CreatePackReview | Submit a Pack for Superhuman GO review |\n| pack | DeleteAllConfigurationsOnPack | Delete all configurations for a Pack |\n| pack | DeletePack | Delete a Pack |\n| pack | DeletePackConfiguration | Delete a Pack configuration |\n| pack | DeletePackConfigurationOAuth | Delete OAuth configuration metadata associated with a Pack configuration |\n| pack | DenyPackAccessRequest | A user was denied access to a Pack |\n| pack | RemovePackConfigurationPermission | Delete a Pack configuration permission |\n| pack | SetPackConfigurationOAuth | Set OAuth configuration metadata associated with the Pack configuration |\n| pack | SetPackConfigurationPermissions | Set permissions for a Pack configuration |\n| pack | UpdatePackConfiguration | Update a Pack configuration |\n| pack | UpdatePackListingDraft | Update a Pack listing draft |\n| pack | UpdatePackPermissions | Update Pack permissions |\n| packControl | SetPackControl | Set Pack control for an organization |\n| syncPage | OpenSyncPage | Opening a sync page for reading. |\n| syncPageTunnel | CreateSyncPageTunnel | Create a sync page tunnel |\n| syncPageTunnel | DeleteSyncPageTunnel | Delete a sync page tunnel |\n| syncPageTunnel | UpdateSyncPageTunnel | Update a sync page tunnel |\n| user | CreateUser | Create a new user |\n| user | DeleteUser | Delete an existing user |\n| user | ExportUserData | Export own personal data |\n| user | IssueOAuthToken | Issue an OAuth access/refresh token for a user |\n| user | LogInUser | Login activity of a user |\n| user | LogOutUser | Logout activity of a user |\n| user | RenewOAuthToken | Renew an OAuth access token for a user |\n| user | ResetUserPassword | Reset a user's password |\n| user | RevokeAllOAuthTokens | Revoke all OAuth tokens for a user |\n| user | RevokeOAuthToken | Revoke a single OAuth refresh token for a user |\n| user | UpdateUserAccount | Update a user's account details |\n| user | UpdateUserPassword | Update a user's password |\n| webhook | CreateWebhook | Create a new webhook subscription |\n| webhook | DeleteWebhook | Delete a webhook subscription |\n| webhook | ResetWebhook | Resets a webhook subscription |\n| webhook | UpdateWebhook | Updates parameters for an existing webhook subscription |\n| workspace | CreateCustomIcon | Create a custom icon in a workspace |\n| workspace | CreateWorkspace | Create a new workspace |\n| workspace | DeleteCustomIcon | Delete a custom icon in a workspace |\n| workspace | DeleteWorkspace | Delete a workspace |\n| workspace | ExportWorkspaceMembers | Export workspace members roster |\n| workspace | OffboardWorkspaceUser | Offboard a removed user from a workspace |\n| workspace | PinDocToWorkspace | Pin a doc to a workspace |\n| workspace | ReinstateWorkspaceUser | Allow a user to be re-added to a workspace |\n| workspace | UnpinDocFromWorkspace | Unpin a doc from a workspace |\n| workspace | UpdateWorkspaceSettings | Update workspace settings |\n| workspace | UpdateWorkspaceUserBrainRole | Update a user's Brain role in a workspace |\n| workspace | UpdateWorkspaceUserRole | Update a user's role in a workspace |\n\n### More information\nFor more information about the Superhuman Docs Admin API and these events,\n[detailed information and examples are available](https://docs.superhuman.com/@documentation/admin-audit-api-events-and-documentation).\n\n## Webhooks\n\nWebhooks enable an application to receive notifications of audit events in Superhuman Docs as they occur.\n\nRather than having to \"poll\" repeatedly for new audit events, a webhook will \"push\" events to your internet-accessible\nendpoint via HTTP `POST` requests. This can be much more efficient and convenient for an internet-accessible service.\n\nIt is important to note that webhooks do require a server or server-like endpoint accesible on the internet at all times\nto receive these notifications. For simpler scenarios, it may be easier to just poll for audit events rather than host\nand maintain a server on the internet.\n\n### Webhook Considerations\n\nThis webhook implementation aims to deliver events within a few minutes of occurring under normal operating conditions.\n\nThe system will attempt retries when it detects failures, so it will be possible for you to receive the same events\nmore than once depending on errors or timeouts occurring in your server or in the network infrastructure between Superhuman Docs\nand your server. Once delivered successfully, it is not possible to replay webhook notifications.\n\nTargets are expected to respond within 10 seconds before delivery times out and is considered a failure.\n\nFailures are retried using exponential backoff timing; after 8 hours of consecutive failures, Superhuman Docs will give up and\nplace the webhook into a disabled state.\n\n### Webhook Setup\n\nOnce a new webhook connection is established, an initial handshake will be attempted in order to prove that the target\nis available on the internet and is owned by the registering entity. In addition, any time the webhook is updated\nto point to a new target URL, the handshake procedure will be kicked off.\n\nAfter the initial handshake completes successfully, new audit events will immediately begin to flow to the target.\n\nIn the event that the handshake fails, the `reset` API can be used to force the webhook to retry the handshake process.\n\n### Webhook Handshake details\n\nTo prove that the target URL is available on the internet and is a valid webhook target, a handshake process is\nstarted anytime a new target URL is set on on a webhook. This process is asynchronous to the webhook setup API call.\n\nSuperhuman Docs will send a HTTP `GET` request to the registered target URL with a HTTP header named `X-Webhook-Code`. The\ntarget must respond with a standard `200` or `204` HTTP response code and echo back the same header key and its value.\n\n### Webhook Payload details\n\nOnce the webhook handshake has completed successfully, Superhuman Docs will send batches of audit events to the target URL using\nHTTP `POST` requests.\n\nEach notifications the target receives will include:\n\n* A `X-Webhook-Signature` header which enables the server to verify the payload is genuine and originated from Superhuman Docs.\nThis code is a SHA-256 HMAC of the stringified body of the POST request using the Superhuman Docs-generated secret key available\non the webhook object.\n* A JSON body with key `events` which contains an array of audit events using the same format as\nreturned by the `listEvents` endpoint detailed below.\n\n### Payload verification\n\nSample javascript code fragment for verifying a webhook payload originated from Superhuman Docs:\n\n```javascript\nconst crypto = require('crypto');\n\n// This field is available on the Superhuman Docs webhook object.\nconst signatureKey = 'some value';\n\n// These come from the webhook `POST` request to your server\nconst headers = {'X-Webhook-Signature': 'abc123'};\nconst body = {events: []};\n\nconst calculatedSignature = crypto\n .createHmac('SHA256', signatureKey)\n .update(JSON.stringify(body))\n .digest(\"hex\");\n\nconst isValidSignature = crypto.timingSafeEqual(\n Buffer.from(calculatedSignature),\n Buffer.from(headers['X-Webhook-Signature']),\n);\n```\n\n## List Endpoints\n\nEndpoints supporting listing of resources have the following fields:\n\n - `items`: An array containing the listed resources, limited by the `limit` or `pageToken` query parameters\n - `nextPageLink`: If more results are available, an API link to the next page of results\n - `nextPageToken`: If more results are available, a page token that can be passed into the `pageToken` query parameter\n\n**The maximum page size may change at any time, and may be different for different endpoints.** Please do not rely on it\nfor any behavior of your application. If you pass a `limit` parameter that is larger than our maximum allowed limit,\nwe will only return as many results as our maximum limit. You should look for the presence of the `nextPageToken` on the\nresponse to see if there are more results available, rather than relying on a result set that matches your provided limit.\n\nTo fetch a subsequent page of results, pass the `pageToken` parameter. Set this parameter to the value given to you as the `nextPageToken`\nin a page response. If no value is provided, there are no more results available. You only need to pass the `pageToken` to get\nthe next page of results, you don't need to pass any of the parameters from your original request, as they are all\nimplied by the `pageToken`. Any other parameters provided alongside a `pageToken` will be ignored.\n\n## Rate Limiting\n\nThe Superhuman Docs Admin API sets a reasonable limit on the number of requests that can be made per minute. Once this limit is\nreached, calls to the API will start returning errors with an HTTP status code of 429.\n\n## OpenAPI/Swagger Spec\n\nIn an effort to standardize our API and make it accessible, we offer an OpenAPI 3.0 specification:\n\n- [OpenAPI 3.0 spec - YAML](https://docs.superhuman.com/apis/admin/v1/openapi.yaml)\n- [OpenAPI 3.0 spec - JSON](https://docs.superhuman.com/apis/admin/v1/openapi.json)\n" termsOfService: https://superhuman.com/legal/terms contact: name: Developer Support url: https://superhuman.com/developers email: care@superhuman.com x-logo: url: https://cdn.coda.io/icons/png/color/superhuman-docs-128.png backgroundColor: transparent altText: Superhuman Docs Admin API href: '#' servers: - url: https://docs.superhuman.com/apis/admin/v1 description: Superhuman Docs Admin API (v1) security: - Bearer: [] tags: - name: Packs description: 'Packs are integrations connecting Superhuman Docs to external data sources. ' paths: /organizations/{organizationId}/docs/packConnections: get: summary: List doc Pack connections description: 'Returns a list of Pack connections linked to docs across the organization. ' operationId: listDocPackConnections tags: - Packs parameters: - $ref: '#/components/parameters/organizationId' - name: workspaceId description: Filter down connections to docs within this workspace. in: query example: ws-1Ab234 schema: type: string - name: readAccess description: Filter down connections to those with the specified access to pull in data. in: query example: Anyone schema: $ref: '#/components/schemas/DocPackConnectionReadAccess' - name: writeAccess description: Filter down connections to those with the specified access to perform actions. in: query example: Anyone schema: $ref: '#/components/schemas/DocPackConnectionWriteAccess' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/pageToken' responses: '200': description: List of Pack connections across docs. content: application/json: schema: $ref: '#/components/schemas/DocPackConnectionList' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: "import requests\n\nheaders = {'Authorization': 'Bearer '}\nuri = 'https://docs.superhuman.com/apis/admin/v1/organizations//docs/packConnections'\nparams = {\n 'readAccess': 'Anyone',\n}\nres = requests.get(uri, headers=headers, params=params).json()\n\nprint(f'First connection is for Pack: {res[\"items\"][0][\"pack\"][\"id\"]}')\n# => First connection is for Pack: 1003\n" /packs: get: summary: List Packs description: 'Get the list of accessible Packs. ' operationId: listPacks tags: - Packs parameters: - name: accessType description: Deprecated, use accessTypes instead. Filter to only return the Packs for which the current user has this access type in: query example: edit schema: $ref: '#/components/schemas/PackAccessType' - name: accessTypes description: Filter to only return the Packs for which the current user has these access types. in: query explode: false example: edit schema: type: array items: $ref: '#/components/schemas/PackAccessType' - name: sortBy description: The sort order of the Packs returned. in: query example: true schema: $ref: '#/components/schemas/PacksSortBy' - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/onlyWorkspaceId' - $ref: '#/components/parameters/parentWorkspaceIds' - $ref: '#/components/parameters/excludePublicPacks' - $ref: '#/components/parameters/packEntrypoint' responses: '200': description: List of Pack summaries. content: application/json: schema: $ref: '#/components/schemas/PackSummaryList' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '429': $ref: '#/components/responses/TooManyRequestsError' post: summary: Create Pack description: 'Creates a new Pack, essentially registering a new Pack ID. The contents of the Pack will be uploaded separately. ' operationId: createPack tags: - Packs requestBody: description: Parameters for creating the Pack. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePackRequest' responses: '200': description: Info about the Pack that was just created. content: application/json: schema: $ref: '#/components/schemas/CreatePackResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '429': $ref: '#/components/responses/TooManyRequestsError' x-codeSamples: - label: Python 3.13 lang: python source: 'import requests headers = {''Authorization'': ''Bearer ''} uri = ''https://docs.superhuman.com/apis/v1/packs'' res = requests.post(uri, headers=headers).json() print(f''Your new Pack ID is {res["packId"]}'') # => Your new Pack ID is 123 ' - label: Shell lang: shell source: "curl -s -H 'Authorization: Bearer ' \\\n 'https://docs.superhuman.com/apis/v1/packs' |\n jq .packId\n# => 123\n" - label: Google Apps Script lang: javascript source: '// Import the SuperhumanDocs library via Resource->Libraries...: // 15IQuWOk8MqT50FDWomh57UqWGH23gjsWVWYFms3ton6L-UHmefYHS9Vl SuperhumanDocs.authenticate(''''); Logger.log(''Your new Pack ID is '' + SuperhumanDocs.createPack().packId); // => Your new Pack ID is 123 ' /packs/{packId}: get: summary: Get a single Pack description: 'Returns a single Pack. ' operationId: getPack tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: The requested Pack. content: application/json: schema: $ref: '#/components/schemas/Pack_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' patch: summary: Update Pack description: 'Update an existing Pack for non-versioned fields. ' operationId: updatePack tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters for updating the Pack. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePackRequest' responses: '200': description: Info about the Pack that was just updated. content: application/json: schema: $ref: '#/components/schemas/Pack_2' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' delete: summary: Delete Pack description: 'Delete a given Pack. ' operationId: deletePack tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Confirmation that the Pack deletion was successful. content: application/json: schema: $ref: '#/components/schemas/DeletePackResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/configurations/schema: get: summary: Gets the JSON Schema for Pack configuration. description: 'Returns a JSON Schema applicable for customizing the Pack using Pack configurations. ' operationId: getPackConfigurationSchema tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Response containing the JSON Schema of the Pack configuration. content: application/json: schema: $ref: '#/components/schemas/GetPackConfigurationJsonSchemaResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions: get: summary: List the versions for a Pack. description: 'Get the list of versions of a Pack. ' operationId: listPackVersions parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' tags: - Packs responses: '200': description: List of Pack versions. content: application/json: schema: $ref: '#/components/schemas/PackVersionList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/nextVersion: post: summary: Get the next valid version for a Pack. description: 'Get the next valid version based on the proposed metadata. ' operationId: getNextPackVersion tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: content: application/json: schema: $ref: '#/components/schemas/GetNextPackVersionRequest' responses: '200': description: Next Pack version info. content: application/json: schema: $ref: '#/components/schemas/NextPackVersionInfo' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions/{basePackVersion}/diff/{targetPackVersion}: get: summary: Get the difference between two Pack versions. description: 'Gets information about the difference between the specified previous version and next version of a Pack. ' operationId: getPackVersionDiffs tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/basePackVersion' - $ref: '#/components/parameters/targetPackVersion' responses: '200': description: Diffs between the two Pack versions. content: application/json: schema: $ref: '#/components/schemas/PackVersionDiffs' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions/{packVersion}/register: post: summary: Register Pack version description: 'Registers a new Pack version. This simply returns a signed URL to use for uploading the Pack version definition. Following the completion of the upload, POST to /apis/v1/packs/{packId}/versions/{packVersion} trigger the rest of the creation process. ' operationId: registerPackVersion tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packVersion' requestBody: description: Parameters for registering the Pack. required: true content: application/json: schema: $ref: '#/components/schemas/RegisterPackVersionRequest' responses: '200': description: The information indicating where to upload the Pack version definition. content: application/json: schema: $ref: '#/components/schemas/PackVersionUploadInfo' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions/{packVersion}/uploadComplete: post: summary: Pack version upload complete description: 'Note the completion of the upload of a Pack version bundle in order to create that Pack version. ' operationId: packVersionUploadComplete tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packVersion' requestBody: description: Parameters for Pack version upload complete. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePackVersionRequest' responses: '200': description: Confirmation of successful Pack version creation. content: application/json: schema: $ref: '#/components/schemas/CreatePackVersionResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/releases: post: summary: Create a new Pack release. description: 'Creates a new Pack release based on an existing Pack version. ' operationId: createPackRelease tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to create the Pack release. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePackReleaseRequest' responses: '200': description: The newly created Pack release. content: application/json: schema: $ref: '#/components/schemas/PackRelease' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' get: summary: List the releases for a Pack. description: 'Get the list of releases of a Pack. ' operationId: listPackReleases parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' tags: - Packs responses: '200': description: List of Pack releases. content: application/json: schema: $ref: '#/components/schemas/PackReleaseList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/releases/{packReleaseId}: put: summary: Update an existing Pack release. description: 'Update details of a Pack release. ' operationId: updatePackRelease tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packReleaseId' requestBody: description: Parameters to update the Pack release. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePackReleaseRequest' responses: '200': description: The updated Pack release. content: application/json: schema: $ref: '#/components/schemas/PackRelease' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/reviews: get: summary: List Pack reviews description: List reviews for a specific Pack. operationId: listPackReviews tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: limit in: query description: Maximum number of results to return. schema: type: integer minimum: 1 default: 25 - $ref: '#/components/parameters/pageToken' - name: status in: query description: Filter reviews by status. schema: $ref: '#/components/schemas/PackReviewStatus' responses: '200': description: List of Pack reviews content: application/json: schema: $ref: '#/components/schemas/ListPackReviewsResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' post: summary: Create Pack review description: Submit a Pack for review in Superhuman GO. operationId: createPackReview tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters for creating Pack review. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePackReviewRequest' responses: '200': description: Pack review created successfully content: application/json: schema: $ref: '#/components/schemas/CreatePackReviewResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/reviews/pending/cancel: post: summary: Cancel pending Pack review description: Cancel the pending Pack review for this Pack. Any user with edit permission on the Pack can cancel the review. operationId: cancelPackReview tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Pack review canceled successfully content: application/json: schema: $ref: '#/components/schemas/CancelPackReviewResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/listingDraft: get: summary: Get Pack listing draft description: Get the current listing draft for a Pack. operationId: getPackListingDraft tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: The Pack listing draft content: application/json: schema: $ref: '#/components/schemas/GetPackListingDraftResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' put: summary: Upsert Pack listing draft description: Create or update the listing draft for a Pack. operationId: upsertPackListingDraft tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: The listing draft data to save. required: true content: application/json: schema: $ref: '#/components/schemas/UpsertPackListingDraftRequest' responses: '200': description: The saved Pack listing draft content: application/json: schema: $ref: '#/components/schemas/UpsertPackListingDraftResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' delete: summary: Delete Pack listing draft description: Delete the listing draft for a Pack, discarding any unsaved changes. operationId: deletePackListingDraft tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: The Pack listing draft was deleted content: application/json: schema: $ref: '#/components/schemas/DeletePackListingDraftResponse' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/oauthConfig: put: summary: Set the OAuth configurations of the Pack. description: 'Set the OAuth configurations of the Pack, including client id and secret. ' operationId: setPackOauthConfig tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to set the Pack OAuth configuration. required: true content: application/json: schema: $ref: '#/components/schemas/SetPackOauthConfigRequest' responses: '200': description: The updated OAuth configuration. content: application/json: schema: $ref: '#/components/schemas/PackOauthConfigMetadata' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' get: summary: Retrieve the OAuth configuration of the Pack. description: 'Retrieve the OAuth configuration of the Pack for display purpose. Secrets will be returned with masks. ' operationId: getPackOauthConfig parameters: - $ref: '#/components/parameters/packId' tags: - Packs responses: '200': description: The Pack's OAuth configuration. content: application/json: schema: $ref: '#/components/schemas/PackOauthConfigMetadata' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/systemConnection: put: summary: Set the system connection credentials of the Pack. description: 'Set the system connection credentials of the Pack. ' operationId: setPackSystemConnection tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to set the Pack system connection credentials. required: true content: application/json: schema: $ref: '#/components/schemas/SetPackSystemConnectionRequest' responses: '200': description: The updated system connection. content: application/json: schema: $ref: '#/components/schemas/PackSystemConnectionMetadata' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' patch: summary: Patch the system connection credentials of the Pack. description: 'Patch the system connection credentials of the Pack. ' operationId: patchPackSystemConnection tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to patch the Pack system connection credentials. required: true content: application/json: schema: $ref: '#/components/schemas/PatchPackSystemConnectionRequest' responses: '200': description: The updated system connection. content: application/json: schema: $ref: '#/components/schemas/PackSystemConnectionMetadata' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' get: summary: Retrieve the system connection metadata of the Pack. description: 'Retrieve the system connection metadata of the Pack. ' operationId: getPackSystemConnection parameters: - $ref: '#/components/parameters/packId' tags: - Packs responses: '200': description: The system connection metadata. content: application/json: schema: $ref: '#/components/schemas/PackSystemConnectionMetadata' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/permissions: get: summary: List permissions for a Pack description: 'Get user, workspace, and/or global permissions for a given Pack. ' operationId: getPackPermissions tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: List of Pack permissions. content: application/json: schema: $ref: '#/components/schemas/PackPermissionList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' post: summary: Add a permission for Pack description: 'Create or modify user, workspace, organization, group, or global permissions for a given Pack. ' operationId: addPackPermission tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters for creating/updating Pack permissions. required: true content: application/json: schema: $ref: '#/components/schemas/AddPackPermissionRequest' responses: '200': description: Confirmation of successfully upserting a Pack permission. content: application/json: schema: $ref: '#/components/schemas/AddPackPermissionResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' delete: summary: Delete a user's own permissions for Pack description: 'Delete a user''s own permissions for a given Pack. ' operationId: deleteUserPackPermission tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Confirmation of successfully deleting a user's permissions for a Pack. content: application/json: schema: $ref: '#/components/schemas/DeleteUserPackPermissionsResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/permissions/{permissionId}: delete: summary: Delete a permission for Pack description: 'Delete user, workspace, or global permissions for a given Pack. ' operationId: deletePackPermission tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/permissionId' responses: '200': description: Confirmation of successfully deleting a Pack permission. content: application/json: schema: $ref: '#/components/schemas/DeletePackPermissionResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/invitations: get: summary: List pending Pack invitations for the current user description: 'Get pending Pack invitations for the authenticated user. ' operationId: listUserPackInvitations tags: - Packs parameters: - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' responses: '200': description: List of Pack invitations for the user. content: application/json: schema: $ref: '#/components/schemas/PackInvitationWithPackList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/invitations: get: summary: List invitations for a Pack description: 'Get pending invitations for a given Pack. ' operationId: listPackInvitations tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' responses: '200': description: List of Pack invitations. content: application/json: schema: $ref: '#/components/schemas/PackInvitationList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' post: summary: Create an invitation for Pack description: 'Create an invitation for a user to access a Pack. ' operationId: createPackInvitation tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters for creating Pack invitation. required: true content: application/json: schema: $ref: '#/components/schemas/CreatePackInvitationRequest' responses: '200': description: Confirmation of successfully creating a Pack invitation. content: application/json: schema: $ref: '#/components/schemas/CreatePackInvitationResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/invitations/{invitationId}: put: summary: Update an invitation for Pack description: 'Update the access level of an existing Pack invitation. ' operationId: updatePackInvitation tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/invitationId' requestBody: description: Parameters for updating Pack invitation. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePackInvitationRequest' responses: '200': description: Confirmation of successfully updating a Pack invitation. content: application/json: schema: $ref: '#/components/schemas/UpdatePackInvitationResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' delete: summary: Revoke an invitation for Pack description: 'Revoke a pending Pack invitation. ' operationId: deletePackInvitation tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/invitationId' responses: '200': description: Confirmation of successfully revoking a Pack invitation. content: application/json: schema: $ref: '#/components/schemas/DeletePackInvitationResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/invitations/{invitationId}/reply: post: summary: Reply to a Pack invitation description: 'Reply to a Pack invitation (accept or reject). Requires authentication as the invited user. ' operationId: replyToPackInvitation tags: - Packs parameters: - $ref: '#/components/parameters/invitationId' requestBody: description: Parameters for replying to Pack invitation. required: true content: application/json: schema: $ref: '#/components/schemas/HandlePackInvitationRequest' responses: '200': description: Confirmation of successfully replying to a Pack invitation. content: application/json: schema: $ref: '#/components/schemas/HandlePackInvitationResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/makers: get: summary: List makers for Pack description: 'List makers for a given Pack. ' operationId: listPackMakers tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Confirmation of successfully retrieving Pack makers content: application/json: schema: $ref: '#/components/schemas/ListPackMakersResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/maker: post: summary: Add a maker for Pack description: 'Set a maker for a given Pack. Used to display makers for a Pack in the corresponding Packs page. ' operationId: addPackMaker tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Payload for adding a Pack maker. required: true content: application/json: schema: $ref: '#/components/schemas/AddPackMakerRequest' responses: '200': description: Confirmation of successfully adding a Pack maker. content: application/json: schema: $ref: '#/components/schemas/AddPackMakerResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/maker/{loginId}: delete: summary: Delete a maker for Pack description: 'Delete a maker for a given Pack, who will not be displayed in the corresponding Packs page. ' operationId: deletePackMaker tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/loginId' responses: '200': description: Confirmation of successfully deleting a Pack maker. content: application/json: schema: $ref: '#/components/schemas/DeletePackMakerResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/categories: get: summary: List categories for Pack description: 'List publishing categories for a given Pack. ' operationId: listPackCategories tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: Confirmation of successfully retrieving Pack categories content: application/json: schema: $ref: '#/components/schemas/ListPackCategoriesResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/category: post: summary: Add a category for Pack description: 'Add a publishing category for a given Pack. ' operationId: addPackCategory tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Payload for adding a Pack category. required: true content: application/json: schema: $ref: '#/components/schemas/AddPackCategoryRequest' responses: '200': description: Confirmation of successfully adding a Pack category content: application/json: schema: $ref: '#/components/schemas/AddPackCategoryResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/category/{categoryName}: delete: summary: Delete a category for Pack description: 'Delete a publishing category for a given Pack. ' operationId: deletePackCategory tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/categoryName' responses: '200': description: Confirmation of successfully deleting a Pack category content: application/json: schema: $ref: '#/components/schemas/DeletePackCategoryResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/uploadAsset: post: summary: Upload a Pack asset. description: 'Request a signed s3 URL to upload your Pack asset. ' operationId: uploadPackAsset tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to specify the asset being uploaded. required: true content: application/json: schema: $ref: '#/components/schemas/UploadPackAssetRequest' responses: '200': description: The information indicating where to upload the Pack asset. content: application/json: schema: $ref: '#/components/schemas/PackAssetUploadInfo' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/uploadSourceCode: post: summary: Upload Pack source code. description: 'Request a signed s3 URL to upload your Pack source code. ' operationId: uploadPackSourceCode tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters to specify the source code being uploaded. required: true content: application/json: schema: $ref: '#/components/schemas/UploadPackSourceCodeRequest' responses: '200': description: The information indicating where to upload the Pack source code. content: application/json: schema: $ref: '#/components/schemas/PackSourceCodeUploadInfo' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/assets/{packAssetId}/assetType/{packAssetType}/uploadComplete: post: summary: Pack asset upload complete description: 'Note the completion of the upload of a Pack asset. ' operationId: packAssetUploadComplete tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packAssetId' - $ref: '#/components/parameters/packAssetType' responses: '200': description: Confirmation of successful Pack asset creation. content: application/json: schema: $ref: '#/components/schemas/PackAssetUploadCompleteResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions/{packVersion}/sourceCode/uploadComplete: post: summary: Pack source code upload complete description: 'Note the completion of the upload of a Pack source code. ' operationId: packSourceCodeUploadComplete tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packVersion' requestBody: description: Parameters to specify the source code being uploaded. required: true content: application/json: schema: $ref: '#/components/schemas/PackSourceCodeUploadCompleteRequest' responses: '200': description: Confirmation of successful Pack asset creation. content: application/json: schema: $ref: '#/components/schemas/PackSourceCodeUploadCompleteResponse' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/versions/{packVersion}/sourceCode: get: summary: get the source code for a Pack version. description: 'Get temporary links used to download the source code for the given packId and version ' operationId: getPackSourceCode tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/packVersion' responses: '200': description: The source code associated with the given packId/version content: application/json: schema: $ref: '#/components/schemas/PackSourceCodeInfo' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/listings: get: summary: List the Pack listings accessible to a user. description: 'Get listings of public Packs and Packs created by you. ' operationId: listPackListings parameters: - $ref: '#/components/parameters/packAccessTypes' - $ref: '#/components/parameters/packIds' - $ref: '#/components/parameters/onlyWorkspaceId' - $ref: '#/components/parameters/parentWorkspaceIds' - $ref: '#/components/parameters/excludePublicPacks' - $ref: '#/components/parameters/packEntrypoint' - $ref: '#/components/parameters/certifiedAgentsOnly' - $ref: '#/components/parameters/packCategories' - name: sortBy in: query description: Specify a sort order for the returned Pack listings returned. schema: $ref: '#/components/schemas/PackListingsSortBy' - name: orderBy in: query description: 'Deprecated: use sortBy instead.' schema: $ref: '#/components/schemas/PackListingsSortBy' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/limit_2' - $ref: '#/components/parameters/pageToken' - name: installContext in: query description: Type of installation context for which Pack information is being requested. example: workspace required: false schema: $ref: '#/components/schemas/PackListingInstallContextType' tags: - Packs responses: '200': description: Public Pack listings and Pack listings created by you. content: application/json: schema: $ref: '#/components/schemas/PackListingList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/listing: get: summary: Get detailed listing information for a Pack. description: 'Get detailed listing information for a Pack. ' operationId: getPackListing tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: workspaceId description: ID of the target workspace (if applicable) for checking installation privileges. in: query example: ws-1Ab234 schema: type: string - name: docId description: ID of the target document for checking installation privileges in: query example: fleHfrkw3L schema: type: string - name: ingestionId description: ID of the target ingestion for checking limit settings in: query example: uuid-uuid-uuid-uuid schema: type: string - name: installContext in: query description: Type of installation context for which Pack information is being requested. example: workspace required: false schema: $ref: '#/components/schemas/PackListingInstallContextType' - name: releaseChannel in: query description: Release channel for which Pack information is being requested. example: LIVE required: false schema: $ref: '#/components/schemas/IngestionPackReleaseChannel' responses: '200': description: The Pack listing detail. content: application/json: schema: $ref: '#/components/schemas/PackListingDetail' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/docs/{docId}/logs: get: summary: Retrieve the logs of a Pack. description: 'Retrieve the logs of a Pack for debugging purpose. ' operationId: listPackLogs tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/docId' - name: logTypes description: Only return logs of the given types. in: query explode: false example: fetcher,custom schema: type: array items: $ref: '#/components/schemas/PackLogType' - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true - name: requestIds description: Only return logs matching provided request IDs. in: query explode: false example: 416faabf,4127faag schema: type: array items: type: string responses: '200': description: Pack logs. content: application/json: schema: $ref: '#/components/schemas/PackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/logs: get: summary: Retrieve the logs of a Ingestion. description: Retrieve the logs of a Ingestion for debugging purpose. operationId: listIngestionLogs tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/rootIngestionId' - name: logTypes description: Only return logs of the given types. in: query explode: false example: fetcher,custom schema: type: array items: $ref: '#/components/schemas/PackLogType' - name: ingestionExecutionId description: ID of the ingestion execution. in: query required: false example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: ingestionStatus description: 'Only fetch logs with the given ingestion status. This only works in combination with the onlyExecutionCompletions parameter. ' in: query schema: $ref: '#/components/schemas/IngestionStatus' - name: onlyExecutionCompletions description: Only fetch logs that represent the completion of a child execution. in: query schema: type: boolean - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true - name: requestIds description: Only return logs matching provided request IDs. in: query explode: false example: 416faabf,4127faag schema: type: array items: type: string responses: '200': description: Pack logs. content: application/json: schema: $ref: '#/components/schemas/PackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/docs/{docId}/groupedLogs: get: summary: Retrieve the grouped logs of a Pack. description: 'Retrieve the grouped logs of a Pack for debugging purpose. ' operationId: listGroupedPackLogs tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/docId' - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true responses: '200': description: Grouped Pack logs. content: application/json: schema: $ref: '#/components/schemas/GroupedPackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/groupedLogs: get: summary: Retrieve the grouped logs of a Pack for a specific ingestionExecutionId. description: 'Retrieve the grouped logs of a Pack for debugging purpose. ' operationId: listGroupedIngestionLogs tags: - Packs parameters: - $ref: '#/components/parameters/packId' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/rootIngestionId' - $ref: '#/components/parameters/ingestionExecutionId' - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: context.doc_id:"fleHfrkw3L" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true responses: '200': description: Grouped Pack logs. content: application/json: schema: $ref: '#/components/schemas/GroupedPackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/ingestionBatchExecutions: get: summary: Retrieve a list of ingestion batch executions for the given root ingestion id. description: 'Retrieve the ingestion batch executions of a root ingestion for debugging purpose. ' operationId: listIngestionBatchExecutions tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/rootIngestionId' - $ref: '#/components/parameters/pageToken' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - name: datasource description: Only show batch executions for this datasource (sync table). in: query required: false schema: type: string x-allow-empty: true - name: executionType description: Only show batch executions with this execution type. in: query required: false schema: $ref: '#/components/schemas/IngestionExecutionType' - name: includeDeletedIngestions description: Include deleted ingestion executions in the response in: query required: false schema: type: boolean - name: ingestionExecutionId description: Only retrieve this single batch execution. in: query required: false schema: type: string - name: ingestionId description: Only show batch executions for this sync table ingestion. in: query required: false schema: type: string - name: ingestionStatus description: Only show batch executions with this status. in: query required: false schema: $ref: '#/components/schemas/IngestionStatus' responses: '200': description: list of ingestion batch executions. content: application/json: schema: $ref: '#/components/schemas/IngestionBatchExecutionsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' ? /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/ingestionBatchExecutions/{ingestionExecutionId}/parentItems : get: summary: Retrieve a list of parent items for the given ingestion batch execution id. description: 'Retrieve the parent items of a ingestion batch execution for debugging purpose. ' operationId: listIngestionParentItems tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/rootIngestionId' - $ref: '#/components/parameters/pageToken' - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - name: ingestionExecutionId description: Only show parent items for this ingestion batch execution. in: path required: true schema: type: string format: uuid - name: ingestionId description: The ID of the sync table ingestion. Enables faster lookup. in: query required: true schema: type: string format: uuid - name: ingestionStatus description: Only show parent items with this status. in: query required: false schema: $ref: '#/components/schemas/IngestionStatus' responses: '200': description: list of ingestion parent items. content: application/json: schema: $ref: '#/components/schemas/IngestionParentItemsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/tenantId/{tenantId}/rootIngestionId/{rootIngestionId}/logs/{logId}: get: summary: Retrieve the information for a specific log. description: 'Retrieve the ingestion execution ids of a root ingestion for debugging purpose. ' operationId: getPackLogDetails tags: - Packs parameters: - $ref: '#/components/parameters/packId' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/rootIngestionId' - name: logId in: path description: 'The id of the log to retrieve. ' required: true schema: type: string x-allow-empty: false - name: detailsKey in: query description: 'The key of the details to retrieve. ' required: true schema: type: string x-allow-empty: false responses: '200': description: Pack log details. content: application/json: schema: $ref: '#/components/schemas/PackLogDetails' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /packs/{packId}/featuredDocs: get: summary: List featured docs for a Pack description: 'Returns a list of featured doc ids for a Pack. ' operationId: listPackFeaturedDocs tags: - Packs parameters: - $ref: '#/components/parameters/packId' responses: '200': description: The featured docs for a Pack. content: application/json: schema: $ref: '#/components/schemas/PackFeaturedDocsResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' put: summary: Update featured docs for a Pack description: 'Create or replace the featured docs for a Pack. ' operationId: updatePackFeaturedDocs tags: - Packs parameters: - $ref: '#/components/parameters/packId' requestBody: description: Parameters for updating the Pack's featured docs. required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePackFeaturedDocsRequest' responses: '200': description: Update Pack's featured docs success response content: application/json: schema: $ref: '#/components/schemas/UpdatePackFeaturedDocsResponse' '400': $ref: '#/components/responses/BadRequestError' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/agentSessionIds: get: summary: Retrieve the chat sessions of an agent instance. description: Retrieve the chat sessions of an agent instance for debugging purpose. operationId: listAgentSessionIds tags: - Packs parameters: - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/agentInstanceId' - name: agentSessionId description: ID of the agent chat session. in: query required: false example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid - name: logTypes description: Only return logs of the given types. in: query explode: false example: fetcher,custom schema: type: array items: $ref: '#/components/schemas/PackLogType' - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: trace.id:"a4e293c4-4a85-45a4-b2ba-7f305cba2703" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true - name: requestIds description: Only return logs matching provided request IDs. in: query explode: false example: 416faabf,4127faag schema: type: array items: type: string responses: '200': description: Pack logs. content: application/json: schema: $ref: '#/components/schemas/PackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/logs: get: summary: Retrieve the logs of an agent instance. description: Retrieve the logs of an agent instance for debugging purpose. operationId: listAgentLogs tags: - Packs parameters: - name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 maximum: 100 - $ref: '#/components/parameters/pageToken' - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/agentInstanceId' - name: logTypes description: Only return logs of the given types. in: query explode: false example: fetcher,custom schema: type: array items: $ref: '#/components/schemas/PackLogType' - name: agentSessionId description: ID of the agent chat session. in: query required: false example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid - name: beforeTimestamp description: 'Only return logs before the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: afterTimestamp description: 'Only return logs after the given time (non-inclusive). ' in: query required: false example: '2018-04-11T00:18:57.946Z' schema: type: string format: date-time - name: order description: 'Specifies if the logs will be returned in time desc or asc. Default is desc. ' in: query required: false schema: type: string enum: - asc - desc - name: q description: 'A search query that follows Lucene syntax. ' in: query required: false example: trace.id:"a4e293c4-4a85-45a4-b2ba-7f305cba2703" AND event.action:"FormulaRequest" schema: type: string x-allow-empty: true - name: requestIds description: Only return logs matching provided request IDs. in: query explode: false example: 416faabf,4127faag schema: type: array items: type: string responses: '200': description: Pack logs. content: application/json: schema: $ref: '#/components/schemas/PackLogsList' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' /go/tenants/{tenantId}/agentInstances/{agentInstanceId}/logs/{logId}: get: summary: Retrieve the information for a specific log. description: 'Retrieve the log details of given logId. ' operationId: getAgentPackLogDetails tags: - Packs parameters: - $ref: '#/components/parameters/tenantId' - $ref: '#/components/parameters/agentInstanceId' - name: logId in: path description: 'The id of the log to retrieve. ' required: true schema: type: string x-allow-empty: false - name: detailsKey in: query description: 'The key of the details to retrieve. ' required: true schema: type: string x-allow-empty: false responses: '200': description: Pack log details. content: application/json: schema: $ref: '#/components/schemas/PackLogDetails' '400': $ref: '#/components/responses/BadRequestWithValidationErrors' '401': $ref: '#/components/responses/UnauthorizedError' '403': $ref: '#/components/responses/ForbiddenError' '404': $ref: '#/components/responses/NotFoundError' '429': $ref: '#/components/responses/TooManyRequestsError' components: schemas: PacksSortBy: x-schema-name: PacksSortBy description: Determines how the Packs returned are sorted. type: string enum: - title - createdAt - updatedAt x-tsEnumNames: - Title - CreatedAt - UpdatedAt MonthlyDocMakerPackPlanPricing: x-schema-name: MonthlyDocMakerPackPlanPricing description: Pricing used when workspaces can subscribe to the Pack for a monthly cost per Doc Maker. type: object required: - type - amount - currency additionalProperties: false properties: type: type: string enum: - MonthlyDocMaker x-tsType: PackPlanPricingType.MonthlyDocMaker amount: type: number description: The monthly cost of the Pack per Doc Maker. currency: $ref: '#/components/schemas/PackPlanCurrency' UpsertPackListingDraftResponse: x-schema-name: UpsertPackListingDraftResponse description: Response containing the upserted Pack listing draft type: object required: - packListingDraftId - packId - listingData additionalProperties: false properties: packListingDraftId: type: string format: uuid description: ID of the listing draft packId: type: number description: ID of the Pack listingData: $ref: '#/components/schemas/PackListingDraftData' PackConnectionAwsAssumeRoleCredentials: x-schema-name: PackConnectionAwsAssumeRoleCredentials type: object required: - type - roleArn - externalId additionalProperties: false properties: type: type: string enum: - awsAssumeRole x-tsType: PackConnectionType.AwsAssumeRole roleArn: type: string externalId: type: string AddPackPermissionRequest: x-schema-name: AddPackPermissionRequest description: Payload for upserting a Pack permission. type: object required: - access - principal additionalProperties: false properties: principal: $ref: '#/components/schemas/PackPrincipal' access: $ref: '#/components/schemas/PackAccessType' DeletePackPermissionResponse: x-schema-name: DeletePackPermissionResponse description: Confirmation of successfully deleting a Pack permission. type: object additionalProperties: false properties: {} PackSourceCodeUploadCompleteRequest: x-schema-name: PackSourceCodeUploadCompleteRequest description: Payload for noting a Pack source code upload is complete. type: object additionalProperties: false required: - filename - codeHash properties: filename: type: string example: main.ts codeHash: type: string example: 123456 description: A SHA-256 hash of the source code used to identify duplicate uploads. IngestionTableSetting: x-schema-name: IngestionTableSetting description: Ingestion settings for a specific table type: object additionalProperties: false properties: maxBytesPerSyncTableOverride: type: number description: The bytes limit when ingesting data for this table. null means no limit. nullable: true excludeIngestionByDefault: type: boolean description: Whether to exclude this table from ingestions by default. parameterLimits: type: object description: Limits for allowed parameter values. additionalProperties: $ref: '#/components/schemas/ParameterSetting' PackVersionList: x-schema-name: PackVersionList description: List of Pack versions. type: object required: - items - creationUsers additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackVersion' creationUsers: type: array items: $ref: '#/components/schemas/UserSummary' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs/1/versions?pageToken=xyz UploadPackSourceCodeRequest: x-schema-name: UploadPackSourceCodeRequest description: Payload for a Pack asset upload. type: object additionalProperties: false required: - filename - payloadHash properties: payloadHash: type: string description: The SHA-256 hash of the image to be uploaded. example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b filename: type: string example: main.ts packVersion: type: string example: 1.0.0 PackInvitationList: x-schema-name: PackInvitationList description: List of Pack invitations. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackInvitation' nextPageToken: type: string nullable: true description: Token for fetching the next page of results nextPageLink: type: string format: url nullable: true description: URL for fetching the next page of results PackLogDetails: x-schema-name: PackLogDetails description: Details for a Pack log. oneOf: - $ref: '#/components/schemas/PackFetcherLogDetails' - $ref: '#/components/schemas/PackInvocationLogDetails' - $ref: '#/components/schemas/PackAgentRuntimeLogDetails' discriminator: propertyName: type mapping: invocation: '#/components/schemas/PackInvocationLogDetails' fetcher: '#/components/schemas/PackFetcherLogDetails' agentRuntime: '#/components/schemas/PackAgentRuntimeLogDetails' IngestionExecutionType: x-schema-name: IngestionExecutionType description: Type of an ingestion batch execution. type: string enum: - FULL - INCREMENTAL x-tsEnumNames: - Full - Incremental PackSourceCodeVisibility: x-schema-name: PackSourceCodeVisibility description: Visibility of a Pack's source code. type: string enum: - private - shared x-tsEnumNames: - Private - Shared PackLog: x-schema-name: PackLog description: A record of Pack log. oneOf: - $ref: '#/components/schemas/PackCustomLog' - $ref: '#/components/schemas/PackInvocationLog' - $ref: '#/components/schemas/PackFetcherLog' - $ref: '#/components/schemas/PackInternalLog' - $ref: '#/components/schemas/PackAuthLog' - $ref: '#/components/schemas/PackIngestionLifecycleLog' - $ref: '#/components/schemas/PackIngestionDebugLog' - $ref: '#/components/schemas/PackAgentRuntimeLog' - $ref: '#/components/schemas/PackMcpLog' discriminator: propertyName: type mapping: custom: '#/components/schemas/PackCustomLog' fetcher: '#/components/schemas/PackInvocationLog' invocation: '#/components/schemas/PackFetcherLog' internal: '#/components/schemas/PackInternalLog' auth: '#/components/schemas/PackAuthLog' ingestionLifecycle: '#/components/schemas/PackIngestionLifecycleLog' ingestionDebug: '#/components/schemas/PackIngestionDebugLog' agentRuntime: '#/components/schemas/PackAgentRuntimeLog' mcp: '#/components/schemas/PackMcpLog' PackDiscoverability: x-schema-name: PackDiscoverability description: Widest principal a Pack is available to. type: string enum: - public - nomosOrganization - group - grammarlyInstitution - workspace - private x-tsEnumNames: - Public - NomosOrganization - Group - GrammarlyInstitution - Workspace - Private PackSourceCode: x-schema-name: PackSourceCode description: Details about a Pack's source code. type: object additionalProperties: false required: - filename - url properties: filename: type: string description: name of the file example: main.ts url: type: string description: The URL to download the source code from example: https://coda-us-west-2-prod-packs.s3.us-west-2.amazonaws.com/packs/123/1/main.ts DeletePackResponse: x-schema-name: DeletePackResponse description: Confirmation of successful Pack deletion. type: object additionalProperties: false properties: {} PackOrganizationAccessForDocs: x-schema-name: PackOrganizationAccessForDocs description: Describes restrictions that a user's organization has placed on a Pack type: object required: - canRequestAccess - hasRequestedAccess - requiresConfiguration additionalProperties: false properties: canRequestAccess: type: boolean hasRequestedAccess: type: boolean requiresConfiguration: type: boolean allowedConfigurations: type: array items: $ref: '#/components/schemas/PackConfigurationEntry' allowedPackIds: type: array items: type: number incompatibleDocPermissions: type: array items: $ref: '#/components/schemas/Permission_2' incompatibleDocOwner: $ref: '#/components/schemas/UserSummary' incompatibleDocFolder: $ref: '#/components/schemas/FolderReference' isDocOwner: type: boolean FeaturedDocStatus: x-schema-name: FeaturedDocStatus description: Status of featured doc in Pack listing. type: string enum: - docInaccessibleOrDoesNotExist - invalidPublishedDocUrl x-tsEnumNames: - DocInaccessibleOrDoesNotExist - InvalidPublishedDocUrl DeleteUserPackPermissionsResponse: x-schema-name: DeleteUserPackPermissionsResponse description: Confirmation of successfully deleting a user's permissions for a Pack. type: object additionalProperties: false properties: {} CreatePackResponse: x-schema-name: CreatePackResponse description: Info about a Pack that was just created. type: object required: - packId additionalProperties: false properties: packId: type: number description: The ID assigned to the newly-created Pack. example: 123 PackListing: x-schema-name: PackListing description: A Pack listing. type: object additionalProperties: false required: - packId - packVersion - name - shortDescription - description - logoUrl - logo - externalMetadataUrl - categories - makers - sdkVersion - packCategoryType properties: packId: type: number description: ID of the Pack. example: 1003 packVersion: type: string description: The version of the Pack. example: 1.0.3 releaseId: type: number description: The current release number of the Pack if released, otherwise undefined. example: 2 lastReleasedAt: type: string format: date-time description: The timestamp of the latest release of this Pack. example: '2018-04-11T00:18:57.946Z' logoUrl: type: string format: url description: The link to the logo of the Pack. deprecated: true logo: $ref: '#/components/schemas/PackImageFile' coverUrl: type: string format: url description: The link to the cover photo of the Pack. deprecated: true cover: $ref: '#/components/schemas/PackImageFile' exampleImages: type: array items: $ref: '#/components/schemas/PackImageFile' description: The example images for the Pack. agentImages: type: array items: $ref: '#/components/schemas/PackImageFile' description: The agent images for the Pack. name: type: string description: The name of the Pack. example: Cool Geometry Formulas description: type: string description: The full description of the Pack. example: This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. example: Calculate cool geometric formulas like surface area. agentShortDescription: type: string description: A short description for the Pack as an agent. example: Chat with a tool that can calculate cool geometric formulas like surface area. agentDescription: type: string description: A full description for the Pack as an agent. example: Chat with a comprehensive tool that can calculate cool geometric formulas like surface area, volume, and other mathematical operations. This agent can help with complex calculations and provide detailed explanations. supportEmail: type: string description: A contact email for the Pack. example: user@email.com termsOfServiceUrl: type: string format: url description: A Terms of Service URL for the Pack. privacyPolicyUrl: type: string format: url description: A Privacy Policy URL for the Pack. categories: type: array description: Publishing Categories associated with this Pack. items: $ref: '#/components/schemas/PublishingCategory' makers: type: array description: Makers associated with this Pack. items: $ref: '#/components/schemas/MakerSummary' certified: type: boolean description: Denotes if the Pack is certified by Superhuman. certifiedAgent: type: boolean description: Denotes if the Pack is certified by Superhuman to be optimized for agent usage. minimumFeatureSet: $ref: '#/components/schemas/FeatureSet_2' unrestrictedFeatureSet: $ref: '#/components/schemas/FeatureSet_2' externalMetadataUrl: type: string description: The URL where complete metadata about the contents of the Pack version can be downloaded. example: https://codahosted.io/packs/12345/1.2.3/metadata/0c892064aa5cb.json standardPackPlan: $ref: '#/components/schemas/StandardPackPlan' bundledPackPlan: $ref: '#/components/schemas/BundledPackPlan' sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' sdkVersion: type: string description: What Packs SDK version was this version built on. example: 1.5.1 packCategoryType: $ref: '#/components/schemas/PackCategoryType' PackGroupPrincipal: x-schema-name: PackGroupPrincipal type: object required: - type - groupId additionalProperties: false properties: type: type: string enum: - group x-tsType: PackPrincipalType.Group groupId: type: string groupName: type: string IngestionBatchExecutionsList: x-schema-name: IngestionBatchExecutionsList description: List of Ingestion Batch Executions. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/IngestionBatchExecution' nextPageToken: $ref: '#/components/schemas/nextPageToken' PackPermission: x-schema-name: PackPermission description: Metadata about a Pack permission. type: object required: - id - principal - access additionalProperties: false properties: id: type: string description: Id for the Permission principal: $ref: '#/components/schemas/PackPrincipal' access: $ref: '#/components/schemas/PackAccessType' GroupedPackLogsList: x-schema-name: GroupedPackLogsList description: List of grouped Pack logs. type: object required: - items - incompleteRelatedLogs additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/GroupedPackLog' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs/1/groupedLogs?pageToken=xyz incompleteRelatedLogs: type: boolean description: This flag will be set to true if the result doens't include all the related logs. IngestionLimitSettings: x-schema-name: IngestionLimitSettings description: Limits for a Pack-driven ingestion type: object additionalProperties: false required: - maxBytesPerSyncTableDefault - allowedTablesCount properties: tableSettings: type: object description: 'Map from table name to per table settings. This may not include every table in the Pack. Each setting per table will include an optional maxBytesPerSyncTableOverride that will override the default, an optional excludeIngestionByDefault flag, and an optional parameterLimits dictionary of allowed parameter values. ' additionalProperties: $ref: '#/components/schemas/IngestionTableSetting' maxBytesPerSyncTableDefault: type: number description: The default bytes limit when ingesting data for a table in the Pack. null means no limit. nullable: true allowedTablesCount: type: number description: The maximum number of tables that can be included. -1 means no limit. nextPageLink: description: If specified, a link that can be used to fetch the next page of results. type: string format: url IngestionParentItemsList: x-schema-name: IngestionParentItemsList description: List of Ingestion Parent Items. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/IngestionParentItem' nextPageToken: $ref: '#/components/schemas/nextPageToken' CreatePackRequest: x-schema-name: CreatePackRequest description: Payload for creating a Pack. type: object additionalProperties: false properties: workspaceId: type: string description: The parent workspace for the Pack. If unspecified, the user's default workspace will be used. example: ws-asdf name: type: string description: The name for the Pack. example: Trigonometry description: type: string description: A brief description of the Pack. example: Common trigonometric functions. sourcePackId: type: number description: The ID of the new Pack's source, if this new Pack was forked. nullable: true example: 10029 PackSource: x-schema-name: PackSource type: string enum: - web - cli x-tsEnumNames: - Web - Cli BundledPackPlan: x-schema-name: BundledPackPlan description: The Pack plan to show the Pack can be accessed if the workspace is at least the given tier. type: object required: - packPlanId - packId - pricing - createdAt additionalProperties: false properties: packPlanId: type: string packId: type: number pricing: $ref: '#/components/schemas/BundledPackPlanPricing' createdAt: type: string format: date-time description: Timestamp for when the Pack plan was created. example: '2018-04-11T00:18:57.946Z' AddPackPermissionResponse: x-schema-name: AddPackPermissionResponse description: Confirmation of successfully upserting a Pack permission. type: object required: - permissionId additionalProperties: false properties: permissionId: type: string description: The ID of the permission created or updated. PackFeaturedDocsResponse: x-schema-name: PackFeaturedDocsResponse description: List of a Pack's featured docs. type: object required: - items additionalProperties: false properties: items: type: array description: A list of featured docs for the Pack. items: $ref: '#/components/schemas/PackFeaturedDoc' PackAssetType: x-schema-name: PackAssetType type: string enum: - logo - cover - exampleImage - agentImage x-tsEnumNames: - Logo - Cover - ExampleImage - AgentImage User: x-schema-name: User description: Info about the user who initiated an action. type: object required: - type - id - email additionalProperties: false properties: type: type: string description: The type of this resource. enum: - user x-tsType: Type.User id: type: number description: Internal Superhuman Docs ID of the user. example: 867102 email: type: string description: Email address of the user. example: user@example.com PackConnectionAwsAssumeRoleMetadata: x-schema-name: PackConnectionAwsAssumeRoleMetadata type: object required: - type - service - roleArn - externalId additionalProperties: false properties: type: type: string enum: - awsAssumeRole x-tsType: PackConnectionType.AwsAssumeRole service: type: string roleArn: type: string externalId: type: string PackFeaturedDoc: x-schema-name: PackFeaturedDoc description: A Pack's featured doc. type: object required: - doc - isPinned additionalProperties: false properties: doc: $ref: '#/components/schemas/DocReference' isPinned: type: boolean description: Whether or not this featured doc is pinned. docStatus: $ref: '#/components/schemas/FeaturedDocStatus' publishedUrl: type: string format: url description: The URL of the published doc, if available. StandardPackPlan: x-schema-name: StandardPackPlan description: The Pack plan to show the Pack can be subscribed to at a monthly cost per Doc Maker or for free. type: object required: - packPlanId - packId - pricing - createdAt additionalProperties: false properties: packPlanId: type: string packId: type: number pricing: oneOf: - $ref: '#/components/schemas/FreePackPlanPricing' - $ref: '#/components/schemas/MonthlyDocMakerPackPlanPricing' description: Pricing to show how workspaces can subscribe to the Pack. createdAt: type: string format: date-time description: Timestamp for when the Pack plan was created. example: '2018-04-11T00:18:57.946Z' GroupedPackAuthLog: x-schema-name: GroupedPackAuthLog description: Grouped logs of the Pack's auth requests. type: object required: - type - authLog - relatedLogs additionalProperties: false properties: type: type: string enum: - auth x-tsType: PackLogType.Auth authLog: $ref: '#/components/schemas/PackAuthLog' relatedLogs: type: array items: $ref: '#/components/schemas/PackLog' PackConnectionMultiHeaderCredentials: x-schema-name: PackConnectionMultiHeaderCredentials type: object required: - type - tokens additionalProperties: false properties: type: type: string enum: - multiHeader x-tsType: PackConnectionType.MultiHeader tokens: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string CreatePackReviewResponse: x-schema-name: CreatePackReviewResponse description: Response containing created review information type: object required: - packReviewId additionalProperties: false properties: packReviewId: type: string format: uuid description: ID of the created review MinPermissionCount: x-schema-name: MinPermissionCount description: Minimum count of permissions. type: object required: - type - minCount additionalProperties: false properties: type: type: string description: The type of this resource. enum: - minCount x-tsType: PermissionCountType.MinCount minCount: type: number description: Minimum count of permissions. SetPackOauthConfigRequest: x-schema-name: SetPackOauthConfigRequest description: Request to set the Pack OAuth configuration. type: object additionalProperties: false properties: clientId: type: string clientSecret: type: string redirectUri: type: string PackConnectionOauth2ClientCredentials: x-schema-name: PackConnectionOauth2ClientCredentials type: object required: - type - clientId - clientSecret additionalProperties: false properties: type: type: string enum: - oauth2ClientCredentials x-tsType: PackConnectionType.OAuth2ClientCredentials clientId: type: string maxLength: 512 clientSecret: type: string maxLength: 512 PackConnectionAwsAccessKeyCredentials: x-schema-name: PackConnectionAwsAccessKeyCredentials type: object required: - type - accessKeyId - secretAccessKey additionalProperties: false properties: type: type: string enum: - awsAccessKey x-tsType: PackConnectionType.AwsAccessKey accessKeyId: type: string secretAccessKey: type: string PackReleaseList: x-schema-name: PackReleaseList description: List of Pack releases. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackRelease' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs/1/releases?pageToken=xyz ExactPermissionCount: x-schema-name: ExactPermissionCount description: Exact count of permissions. type: object required: - type - exactCount additionalProperties: false properties: type: type: string description: The type of this resource. enum: - exactCount x-tsType: PermissionCountType.ExactCount exactCount: type: number description: Exact count of permissions. PackSystemConnectionCredentials: x-schema-name: PackSystemConnectionCredentials description: Credentials of a Pack connection. oneOf: - $ref: '#/components/schemas/PackConnectionHeaderCredentials' - $ref: '#/components/schemas/PackConnectionMultiHeaderCredentials' - $ref: '#/components/schemas/PackConnectionUrlParamCredentials' - $ref: '#/components/schemas/PackConnectionHttpBasicCredentials' - $ref: '#/components/schemas/PackConnectionCustomCredentials' - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentials' - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountCredentials' - $ref: '#/components/schemas/PackConnectionAwsAssumeRoleCredentials' - $ref: '#/components/schemas/PackConnectionAwsAccessKeyCredentials' discriminator: propertyName: type mapping: header: '#/components/schemas/PackConnectionHeaderCredentials' multiHeader: '#/components/schemas/PackConnectionMultiHeaderCredentials' urlParam: '#/components/schemas/PackConnectionUrlParamCredentials' httpBasic: '#/components/schemas/PackConnectionHttpBasicCredentials' custom: '#/components/schemas/PackConnectionCustomCredentials' oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentials' googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountCredentials' awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRoleCredentials' awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyCredentials' DeletePackCategoryResponse: x-schema-name: DeletePackCategoryResponse description: Confirmation of successfully deleting a Pack category. type: object additionalProperties: false properties: {} PackConnectionUrlParamCredentials: x-schema-name: PackConnectionUrlParamCredentials type: object required: - type - params additionalProperties: false properties: type: type: string enum: - urlParam x-tsType: PackConnectionType.UrlParam params: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string GetPackConfigurationJsonSchemaResponse: x-schema-name: GetPackConfigurationJsonSchemaResponse description: JSON schema response. type: object additionalProperties: true DocReference: x-schema-name: DocReference description: Reference to a document. type: object required: - id - type - browserLink - href additionalProperties: false properties: id: type: string description: ID of the document. example: AbCDeFGH type: type: string description: The type of this resource. enum: - doc x-tsType: Type.Doc href: type: string format: url description: API link to the document. example: https://docs.superhuman.com/apis/v1/docs/AbCDeFGH browserLink: type: string format: url description: Browser-friendly link to the document. example: https://docs.superhuman.com/d/_dAbCDeFGH ListPackReviewsResponse: x-schema-name: ListPackReviewsResponse description: Response containing Pack reviews type: object required: - items additionalProperties: false properties: items: type: array description: List of Pack reviews items: $ref: '#/components/schemas/PackReview' nextPageToken: type: string description: Token for fetching the next page of results nextPageLink: type: string format: url description: Link for fetching the next page of results PackAccessType: x-schema-name: PackAccessType type: string enum: - none - view - test - edit - admin x-tsEnumNames: - None - View - Test - Edit - Admin PackListingsSortBy: x-schema-name: PackListingsSortBy description: Determines how the Pack listings returned are sorted. type: string enum: - packId - name - packVersion - packVersionModifiedAt - agentDirectorySort x-tsEnumNames: - PackId - Name - PackVersion - PackVersionModifiedAt - AgentDirectorySort DeletePackInvitationResponse: x-schema-name: DeletePackInvitationResponse description: Confirmation of successfully deleting a Pack invitation. type: object additionalProperties: false properties: {} PackListingList: x-schema-name: PackListingList description: A list of Pack listings. type: object additionalProperties: false required: - items properties: items: type: array items: $ref: '#/components/schemas/PackListing' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs/listings?pageToken=xyz PackCategoryType: x-schema-name: PackCategoryType description: The category of a Pack. type: string enum: - connector - agent - customAgent x-tsEnumNames: - Connector - Agent - CustomAgent PackConnectionOauth2ClientCredentialsMetadata: x-schema-name: PackConnectionOauth2ClientCredentialsMetadata type: object required: - type - location - maskedClientId - maskedClientSecret additionalProperties: false properties: type: type: string enum: - oauth2ClientCredentials x-tsType: PackConnectionType.OAuth2ClientCredentials location: $ref: '#/components/schemas/PackOAuth2ClientCredentialsLocation' maskedClientId: type: string maskedClientSecret: type: string PackListingDraftData: x-schema-name: PackListingDraftData description: Draft listing data for a Pack. All fields are optional. type: object additionalProperties: false properties: name: type: string description: The name of the Pack. maxLength: 128 description: type: string description: The full description of the Pack. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. maxLength: 256 logo: $ref: '#/components/schemas/PackImageFile' cover: $ref: '#/components/schemas/PackImageFile' exampleImages: type: array nullable: true items: $ref: '#/components/schemas/PackImageFile' agentImages: type: array nullable: true items: $ref: '#/components/schemas/PackImageFile' categoryIds: type: array items: type: string supportEmail: type: string nullable: true maxLength: 512 termsOfServiceUrl: type: string format: url nullable: true maxLength: 512 privacyPolicyUrl: type: string format: url nullable: true maxLength: 512 sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' agentShortDescription: type: string nullable: true maxLength: 256 agentDescription: type: string nullable: true maxLength: 8192 additionalInformation: $ref: '#/components/schemas/PackListingAdditionalInformation' IngestionStatus: x-schema-name: IngestionStatus description: Status of the ingestion execution. type: string enum: - QUEUED - STARTED - CANCELLED - UP_FOR_RETRY - COMPLETED - FAILED x-tsEnumNames: - Queued - Started - Cancelled - UpForRetry - Completed - Failed FolderReference: x-schema-name: FolderReference description: Reference to a Superhuman Docs folder. type: object required: - id - type - browserLink additionalProperties: false properties: id: type: string description: ID of the Superhuman Docs folder. example: fl-1Ab234 type: type: string description: The type of this resource. enum: - folder x-tsType: Type.Folder browserLink: type: string format: url description: Browser-friendly link to the folder. example: https://docs.superhuman.com/folders/fl-1Ab234 name: type: string description: Name of the folder; included if the user has access to the folder. example: My docs PackConnectionOauth2ClientCredentialsPatch: x-schema-name: PackConnectionOauth2ClientCredentialsPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - oauth2ClientCredentials x-tsType: PackConnectionType.OAuth2ClientCredentials clientId: type: string maxLength: 512 clientSecret: type: string maxLength: 512 PackInternalLog: x-schema-name: PackInternalLog description: Superhuman Docs internal logs from the Packs infrastructure. Only visible to Superhuman employees. type: object required: - type - context - message - level additionalProperties: false properties: type: type: string enum: - internal x-tsType: PackLogType.Internal context: $ref: '#/components/schemas/PackLogContext' message: type: string description: The log message. level: $ref: '#/components/schemas/LogLevel' PackLogRequestType: x-schema-name: PackLogRequestType description: The context request type where a Pack log is generated. type: string enum: - unknown - connectionNameMetadataRequest - parameterAutocompleteMetadataRequest - postAuthSetupMetadataRequest - propertyOptionsMetadataRequest - getSyncTableSchemaMetadataRequest - getDynamicSyncTableNameMetadataRequest - listSyncTableDynamicUrlsMetadataRequest - searchSyncTableDynamicUrlsMetadataRequest - getDynamicSyncTableDisplayUrlMetadataRequest - getIdentifiersForConnectionRequest - invokeFormulaRequest - invokeSyncFormulaRequest - invokeSyncUpdateFormulaRequest - invokeExecuteGetPermissionsRequest - validateParametersMetadataRequest - mcp x-tsEnumNames: - Unknown - ConnectionNameMetadataRequest - ParameterAutocompleteMetadataRequest - PostAuthSetupMetadataRequest - PropertyOptionsMetadataRequest - GetSyncTableSchemaMetadataRequest - GetDynamicSyncTableNameMetadataRequest - ListSyncTableDynamicUrlsMetadataRequest - SearchSyncTableDynamicUrlsMetadataRequest - GetDynamicSyncTableDisplayUrlMetadataRequest - ValidateParametersMetadataRequest - GetIdentifiersForConnectionRequest - InvokeFormulaRequest - InvokeSyncFormulaRequest - InvokeSyncUpdateFormulaRequest - InvokeExecuteGetPermissionsRequest - Mcp CreatePackReleaseRequest: x-schema-name: CreatePackReleaseRequest description: Payload for creating a new Pack release. type: object required: - packVersion additionalProperties: false properties: packVersion: type: string description: Which semantic Pack version that the release will be created on. example: 1.0.0 releaseNotes: type: string description: Developers notes. example: The first release. UpsertPackListingDraftRequest: x-schema-name: UpsertPackListingDraftRequest description: Request to create or update a Pack listing draft type: object required: - listingData additionalProperties: false properties: listingData: $ref: '#/components/schemas/PackListingDraftInputData' PackUserPrincipal: x-schema-name: PackUserPrincipal type: object required: - type - email additionalProperties: false properties: type: type: string enum: - user x-tsType: PackPrincipalType.User email: type: string FeatureSet_2: x-schema-name: FeatureSet deprecated: true description: Only relevant for original Superhuman Packs. type: string enum: - Basic - Pro - Team - Enterprise x-tsEnumNames: - Basic - Pro - Team - Enterprise PackConnectionHeaderPatch: x-schema-name: PackConnectionHeaderPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - header x-tsType: PackConnectionType.Header token: type: string PackReview: x-schema-name: PackReview description: A Pack review submission type: object required: - packReviewId - packId - packReviewStatus - submittedByUserId - submissionTimestamp additionalProperties: false properties: packReviewId: type: string format: uuid description: ID of the review packId: type: integer description: ID of the Pack being reviewed packVersion: type: string description: Pack version being reviewed (for code reviews) includesListingReview: type: boolean description: Whether listing info was included in the review scope packReviewStatus: $ref: '#/components/schemas/PackReviewStatus' submittedByUserId: type: integer description: User ID of the person who submitted the review submissionTimestamp: type: string format: date-time description: When the review was submitted additionalInformation: $ref: '#/components/schemas/PackReviewAdditionalInformation' CreatePackVersionResponse: x-schema-name: CreatePackVersionResponse description: Confirmation of successful Pack version creation. type: object additionalProperties: false properties: deprecationWarnings: type: array items: $ref: '#/components/schemas/ValidationError' PackConnectionHeaderMetadata: x-schema-name: PackConnectionHeaderMetadata type: object required: - type - headerName - tokenPrefix additionalProperties: false properties: type: type: string enum: - header x-tsType: PackConnectionType.Header maskedToken: type: string headerName: type: string tokenPrefix: type: string UpdatePackInvitationRequest: x-schema-name: UpdatePackInvitationRequest description: Payload for updating a Pack invitation. type: object required: - access additionalProperties: false properties: access: $ref: '#/components/schemas/PackAccessType' Pack_2: x-schema-name: Pack description: Details about a Pack. type: object additionalProperties: false required: - id - name - description - shortDescription - workspaceId - categories properties: id: type: number description: ID of the Pack. example: 1003 logoUrl: type: string format: url description: The link to the logo of the Pack. coverUrl: type: string format: url description: The link to the cover photo of the Pack. exampleImages: type: array description: The example images for the Pack. items: $ref: '#/components/schemas/PackImageFile' agentImages: type: array description: The agent images for the Pack. items: $ref: '#/components/schemas/PackImageFile' workspaceId: type: string description: The parent workspace for the Pack. example: ws-asdf categories: type: array description: Publishing categories associated with this Pack. items: $ref: '#/components/schemas/PublishingCategory' certified: type: boolean description: Denotes if the Pack is certified by Superhuman. certifiedAgent: type: boolean description: Denotes if the Pack is certified by Grammarly to be optimized for agent usage. sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' packEntrypoints: type: array description: Pack entrypoints where this Pack is available items: $ref: '#/components/schemas/PackEntrypoint' verifiedVersion: type: string description: The latest released Pack version that has been verified (approved) for use. For agent Packs, this is the most recent release that passed review. For non-agent Packs or legacy releases, this is the most recent release. example: 1.0.0 name: type: string description: The name of the Pack. example: Cool Geometry Formulas maxLength: 128 description: type: string description: The full description of the Pack. example: This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. example: Calculate cool geometric formulas like surface area. maxLength: 256 agentShortDescription: type: string description: A short description for the Pack as an agent. example: Chat with a tool that can calculate cool geometric formulas like surface area. maxLength: 256 agentDescription: type: string description: A full description for the Pack as an agent. example: Chat with a comprehensive tool that can calculate cool geometric formulas like surface area, volume, and other mathematical operations. This agent can help with complex calculations and provide detailed explanations. x-allow-empty: true maxLength: 8192 supportEmail: type: string description: A contact email for the Pack. example: user@email.com maxLength: 512 termsOfServiceUrl: type: string format: url description: A Terms of Service URL for the Pack. maxLength: 512 privacyPolicyUrl: type: string format: url description: A Privacy Policy URL for the Pack. maxLength: 512 overallRateLimit: $ref: '#/components/schemas/PackRateLimit' perConnectionRateLimit: $ref: '#/components/schemas/PackRateLimit' featuredDocStatus: $ref: '#/components/schemas/FeaturedDocStatus' additionalInformation: $ref: '#/components/schemas/PackListingAdditionalInformation' PackConnectionMultiHeaderMetadata: x-schema-name: PackConnectionMultiHeaderMetadata type: object required: - type - headers - presets additionalProperties: false properties: type: type: string enum: - multiHeader x-tsType: PackConnectionType.MultiHeader headers: type: array items: type: object required: - headerName - maskedToken additionalProperties: false properties: headerName: type: string maskedToken: type: string tokenPrefix: type: string presets: type: array items: type: object required: - headerName additionalProperties: false properties: headerName: type: string tokenPrefix: type: string Principal_2: x-schema-name: Principal description: Metadata about a principal. oneOf: - $ref: '#/components/schemas/EmailPrincipal' - $ref: '#/components/schemas/GroupPrincipal' - $ref: '#/components/schemas/DomainPrincipal' - $ref: '#/components/schemas/WorkspacePrincipal' - $ref: '#/components/schemas/AnyonePrincipal' - $ref: '#/components/schemas/InternalAccessPrincipal' discriminator: propertyName: type mapping: email: '#/components/schemas/EmailPrincipal' group: '#/components/schemas/GroupPrincipal' domain: '#/components/schemas/DomainPrincipal' workspace: '#/components/schemas/WorkspacePrincipal' anyone: '#/components/schemas/AnyonePrincipal' internalAccess: '#/components/schemas/InternalAccessPrincipal' GroupPrincipal: type: object required: - groupId - groupName - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - group x-tsType: PrincipalType.Group groupId: type: string description: Group ID for the principal. example: grp-6SM9xrKcqW groupName: type: string description: Name of the group. example: Marketing team DocPackConnectionReadAccess: x-schema-name: DocPackConnectionReadAccess description: Who in the doc has access to read data using the connection. type: string enum: - Anyone - None x-tsEnumNames: - Anyone - None PackWorkspacePrincipal: x-schema-name: PackWorkspacePrincipal type: object required: - type - workspaceId additionalProperties: false properties: type: type: string enum: - workspace x-tsType: PackPrincipalType.Workspace workspaceId: type: string PackConnectionGoogleServiceAccountPatch: x-schema-name: PackConnectionGoogleServiceAccountPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - googleServiceAccount x-tsType: PackConnectionType.GoogleServiceAccount serviceAccountKey: type: string maxLength: 512 GetNextPackVersionRequest: x-schema-name: GetNextPackVersionRequest description: Payload for getting the next version of a Pack. type: object additionalProperties: false required: - proposedMetadata properties: proposedMetadata: type: string description: The metadata for the next version of the Pack. example: '{"formulas": [{"description": "my formula", "name": "foo", "parameters": [], "resultType": 0}]}' sdkVersion: type: string description: The SDK version the metadata was built on. example: 1.0.0 UpdatePackInvitationResponse: x-schema-name: UpdatePackInvitationResponse description: Confirmation of successfully updating a Pack invitation. type: object additionalProperties: false properties: {} PackConnectionAwsAccessKeyPatch: x-schema-name: PackConnectionAwsAccessKeyPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - awsAccessKey x-tsType: PackConnectionType.AwsAccessKey accessKeyId: type: string secretAccessKey: type: string PackLogContext: x-schema-name: PackLogContext description: Logging context that comes with a Pack log. type: object required: - logId - docId - createdAt - packId - packVersion - formulaName - userId - connectionId - requestId - requestType - detailsKey additionalProperties: false properties: docId: type: string packId: type: string packVersion: type: string formulaName: type: string userId: type: string connectionId: type: string connectionName: type: string requestId: type: string description: 'A unique identifier of the Pack invocation that can be used to associate all log types generated in one call of a Pack formula. ' requestType: $ref: '#/components/schemas/PackLogRequestType' createdAt: type: string format: date-time description: Creation time of the log. example: '2018-04-11T00:18:57.946Z' logId: type: string description: Unique identifier of this log record. docObjectId: type: string description: Doc canvas object id where the formula was fired from. docRowId: type: string description: Doc canvas row id where the formula was fired from. docColumnId: type: string description: Doc canvas column id where the formula was fired from. isSyncTable: type: boolean description: True if this is a formula invocation loading a page of a sync table, or metadata for a sync table (like creating a dynamic schema). isContinuedSyncTable: type: boolean description: True if this is an execution of a sync table which received a pagination parameter. autocompleteParameterName: type: string description: If this formula invocation was for a parameter auto-complete, this names the parameter. invocationSource: type: string description: If this formula was invoked by something other than a user action, this should say what that was. detailsKey: type: string description: Key to be used in fetching log details. ingestionChildExecutionIndex: type: number description: Child execution id for this ingestion log. ingestionId: type: string description: Unique identifier of the ingestion that triggered this log. rootIngestionId: type: string description: Unique identifier of the root ingestion that triggered this log. ingestionExecutionId: type: string description: Unique identifier of the ingestion execution that triggered this log. ingestionStage: type: string description: Stage along the ingestion lifecycle that this log was created in. ingestionParentStage: type: string description: An ingestion lifecycle stage that this ingestion log is bundled under. ingestionExecutionAttempt: type: integer description: Execution attempt for this ingestion log. ingestionParentItemId: type: string description: Parent item id for this ingestion log. ingestionProcessId: type: string description: Unique identifier of the ingestion processing call that triggered this log. additionalMetadata: type: object description: Additional metadata for the ingestion log. agentSessionId: type: string description: Agent chat session id. agentInstanceId: type: string description: Agent instance id. executingAgentInstanceId: type: string description: Executing agent instance id. Permission: x-schema-name: Permission description: A specific permission granted to a principal. type: object required: - type - principal - id - access additionalProperties: false properties: type: type: string description: The type of this resource. enum: - permission x-tsType: Type.Permission principal: $ref: '#/components/schemas/Principal' id: type: string description: ID for the Permission access: $ref: '#/components/schemas/AccessType' AddPackMakerRequest: x-schema-name: AddPackMakerRequest description: Payload for adding a Pack maker. type: object required: - loginId additionalProperties: false properties: loginId: type: string description: The email of the Pack maker. example: api@example.com ParameterSetting: x-schema-name: ParameterSetting description: Setting for a specific parameter type: object additionalProperties: false required: - default - allowed properties: default: type: string description: Default value for the parameter allowed: type: array items: type: string UpdatePackFeaturedDocsResponse: x-schema-name: UpdatePackFeaturedDocsResponse description: Confirmation of successful Pack featured docs update. type: object additionalProperties: false properties: {} IngestionChildExecutionType: x-schema-name: IngestionChildExecutionType description: Type of an ingestion childexecution. type: string enum: - FULL - INCREMENTAL - PATCH x-tsEnumNames: - Full - Incremental - Patch GetPackListingDraftResponse: x-schema-name: GetPackListingDraftResponse description: Response containing the Pack listing draft type: object additionalProperties: false properties: packListingDraftId: type: string format: uuid description: ID of the listing draft listingData: $ref: '#/components/schemas/PackListingDraftData' UpdatePackReleaseRequest: x-schema-name: UpdatePackReleaseRequest description: Payload for updating a new Pack release. type: object additionalProperties: false properties: releaseNotes: type: string description: Notes about key features or changes in this release that the Pack maker wants to communicate to users. example: The first release. PackCustomLog: x-schema-name: PackCustomLog description: Pack log generated by developer's custom logging with context.logger. type: object required: - type - context - message - level additionalProperties: false properties: type: type: string enum: - custom x-tsType: PackLogType.Custom context: $ref: '#/components/schemas/PackLogContext' message: type: string description: The message that's passed into context.logger. example: The formula is called! level: $ref: '#/components/schemas/LogLevel' PackConnectionGoogleServiceAccountMetadata: x-schema-name: PackConnectionGoogleServiceAccountMetadata type: object required: - type - maskedServiceAccountKey additionalProperties: false properties: type: type: string enum: - googleServiceAccount x-tsType: PackConnectionType.GoogleServiceAccount maskedServiceAccountKey: type: string DeletePackMakerResponse: x-schema-name: AddPackMakerResponse description: Confirmation of successfully deleting a Pack maker. type: object additionalProperties: false properties: {} PackConnectionAwsAssumeRolePatch: x-schema-name: PackConnectionAwsAssumeRolePatch type: object required: - type additionalProperties: false properties: type: type: string enum: - awsAssumeRole x-tsType: PackConnectionType.AwsAssumeRole roleArn: type: string externalId: type: string PackLogType: x-schema-name: PackLogType type: string enum: - custom - fetcher - invocation - internal - auth - ingestionLifecycle - ingestionDebug - agentRuntime - mcp x-tsEnumNames: - Custom - Fetcher - Invocation - Internal - Auth - IngestionLifecycle - IngestionDebug - AgentRuntime - Mcp DocSearchHit: x-schema-name: DocSearchHit description: Details on where the search query appeared in the doc. type: object required: - matchText - browserLink additionalProperties: false properties: matchText: type: string description: Snippet of text from the doc showing context for the search match. example: 'Objective: Key Results: * Reach feature parity with previous version ' browserLink: type: string format: url description: Browser-friendly link to the location in the document where the search term appears. example: https://docs.superhuman.com/d/_dAbCDeFGH PackSourceCodeUploadCompleteResponse: x-schema-name: PackSourceCodeUploadCompleteResponse description: Response for noting a Pack source code upload is complete. type: object additionalProperties: false required: - requestId properties: requestId: type: string description: An arbitrary unique identifier for this request. example: abc-123-def-456 SetPackSystemConnectionRequest: x-schema-name: SetPackSystemConnectionRequest description: The request to set Pack system connection credentials. type: object additionalProperties: false required: - credentials properties: credentials: $ref: '#/components/schemas/PackSystemConnectionCredentials' PackSystemConnectionMetadata: x-schema-name: PackSystemConnectionMetadata description: Metadata of a Pack system connection. oneOf: - $ref: '#/components/schemas/PackConnectionHeaderMetadata' - $ref: '#/components/schemas/PackConnectionMultiHeaderMetadata' - $ref: '#/components/schemas/PackConnectionUrlParamMetadata' - $ref: '#/components/schemas/PackConnectionHttpBasicMetadata' - $ref: '#/components/schemas/PackConnectionCustomMetadata' - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentialsMetadata' - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountMetadata' - $ref: '#/components/schemas/PackConnectionAwsAssumeRoleMetadata' - $ref: '#/components/schemas/PackConnectionAwsAccessKeyMetadata' discriminator: propertyName: type mapping: header: '#/components/schemas/PackConnectionHeaderMetadata' multiHeader: '#/components/schemas/PackConnectionMultiHeaderMetadata' urlParam: '#/components/schemas/PackConnectionUrlParamMetadata' httpBasic: '#/components/schemas/PackConnectionHttpBasicMetadata' custom: '#/components/schemas/PackConnectionCustomMetadata' oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentialsMetadata' googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountMetadata' awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRoleMetadata' awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyMetadata' HandlePackInvitationRequest: x-schema-name: HandlePackInvitationRequest description: Payload for handling a Pack invitation (accept or reject). type: object required: - accept additionalProperties: false properties: accept: type: boolean description: True to accept the invitation, false to reject it GroupedPackInvocationLog: x-schema-name: GroupedPackInvocationLog description: Grouped logs of the invocations of the Pack. type: object required: - type - invocationLog - relatedLogs additionalProperties: false properties: type: type: string enum: - invocation x-tsType: PackLogType.Invocation invocationLog: $ref: '#/components/schemas/PackInvocationLog' relatedLogs: type: array items: $ref: '#/components/schemas/PackLog' PackConfigurationEntry: x-schema-name: PackConfigurationEntry description: Basic details about a configuration that can be used in conjunction with a Pack type: object required: - configurationId - name additionalProperties: false properties: configurationId: type: string name: description: Name of the configuration type: string policy: type: object description: Policy associated with the configuration additionalProperties: true CreatePackVersionRequest: x-schema-name: CreatePackVersionRequest description: Payload for Pack version upload complete. type: object additionalProperties: false properties: notes: type: string description: Developer notes of the new Pack version. example: Adding a new formula HelloWorld. source: $ref: '#/components/schemas/PackSource' allowOlderSdkVersion: type: boolean description: Bypass the Superhuman Docs protection against SDK version regression when multiple makers build versions. PackFetcherLog: x-schema-name: PackFetcherLog description: System logs of Pack calls to context.fetcher. type: object required: - type - context additionalProperties: false properties: type: type: string enum: - fetcher x-tsType: PackLogType.Fetcher context: $ref: '#/components/schemas/PackLogContext' requestSizeBytes: type: number description: The number of bytes in the HTTP request sent responseCode: type: number responseSizeBytes: type: number description: The number of bytes in the HTTP response received method: type: string enum: - GET - POST - PUT - DELETE - PATCH - HEAD baseUrl: type: string description: base URL of the fetcher request, with all query parameters stripped off. example: https://example.com/api cacheHit: type: boolean description: true if the fetcher request hits catche instead of actually requesting the remote service. duration: description: Duration of the fetcher request in miliseconds. type: number PackLogsList: x-schema-name: PackLogsList description: List of Pack logs. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackLog' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs/1/logs?pageToken=xyz ImageFileForUpdatePackRequest: x-schema-name: ImageFileForUpdatePackRequest description: Information about an image file for an update Pack request. type: object additionalProperties: false required: - assetId - filename properties: assetId: type: string description: The asset id of the Pack's image, returned by [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete) endpoint. filename: type: string description: The filename for the image. mimeType: type: string description: The media type of the image being sent. example: image/jpeg Pack: x-schema-name: Pack description: Info about a Pack. type: object required: - type - id - name properties: type: type: string description: The type of this resource. enum: - pack x-tsType: Type.Pack id: type: number description: ID of the Pack. example: 1003 name: type: string description: The name of the Pack. example: Cool Geometry Formulas DocPackConnection: x-schema-name: DocPackConnection description: Metadata for a Packs connection linked to a doc. type: object required: - type - doc - connectionId - pack - owner - workspace - description - readAccess - writeAccess additionalProperties: false properties: type: type: string description: The type of this resource. enum: - docPackConnection x-tsType: Type.DocPackConnection doc: $ref: '#/components/schemas/Doc' connectionId: type: string description: ID of the connection linked to this doc. example: 88648447-d2c3-4bdb-b476-2150596da2e4 pack: $ref: '#/components/schemas/Pack' owner: $ref: '#/components/schemas/User' workspace: $ref: '#/components/schemas/Workspace' description: type: string description: Description of the Pack connection. example: hello@example.com (2) readAccess: $ref: '#/components/schemas/DocPackConnectionReadAccess' writeAccess: $ref: '#/components/schemas/DocPackConnectionWriteAccess' Permission_2: x-schema-name: Permission description: A specific permission granted to a principal. type: object required: - principal - id - access additionalProperties: false properties: principal: $ref: '#/components/schemas/Principal_2' id: type: string description: Id for the Permission access: $ref: '#/components/schemas/AccessType' PackInvitation: x-schema-name: PackInvitation description: Metadata about a Pack invitation. type: object required: - invitationId - packId - inviteeEmail - inviterUserId - access - createdAt - expiresAt additionalProperties: false properties: invitationId: type: string description: ID of the invitation example: 550e8400-e29b-41d4-a716-446655440000 packId: type: number description: ID of the Pack example: 123 inviteeEmail: type: string description: Email address of the invited user example: user@example.com inviterUserId: type: integer description: User ID of the user who created this invitation example: 456 access: $ref: '#/components/schemas/PackAccessType' createdAt: type: string format: date-time description: Timestamp when the invitation was created expiresAt: type: string format: date-time description: Timestamp when the invitation expires PackConnectionHttpBasicMetadata: x-schema-name: PackConnectionHttpBasicMetadata type: object required: - type additionalProperties: false properties: type: type: string enum: - httpBasic x-tsType: PackConnectionType.HttpBasic maskedUsername: type: string maskedPassword: type: string UpdatePackFeaturedDocsRequest: x-schema-name: UpdatePackFeaturedDocsRequest description: Payload for updating featured docs for a Pack. type: object required: - items additionalProperties: false properties: items: type: array maxItems: 5 uniqueItems: true description: A list of docs to set as the featured docs for a Pack. items: $ref: '#/components/schemas/PackFeaturedDocRequestItem' PackPlanCurrency: x-schema-name: PackPlanCurrency description: Currency needed to subscribe to the Pack. type: string enum: - USD x-tsEnumNames: - Usd PackFetcherLogDetails: x-schema-name: PackFetcherLogDetails description: Details for Pack fetcher logs type: object required: - type - request additionalProperties: false properties: type: type: string enum: - fetcher x-tsType: PackLogType.Fetcher request: type: string response: type: string ValidationError: x-schema-name: ValidationError description: Detail about why a particular field failed request validation. type: object additionalProperties: false required: - path - message properties: path: type: string description: A path indicating the affected field, in OGNL notation. example: parent.child[0] message: type: string description: An error message. example: Expected a string but got a number PackOauthConfigMetadata: x-schema-name: PackOauthConfigMetadata description: The Pack OAuth configuration metadata. type: object additionalProperties: false required: - maskedClientId - maskedClientSecret - authorizationUrl - tokenUrl - redirectUri properties: maskedClientId: type: string description: Masked OAuth client id. If not set, empty string will be returned. maskedClientSecret: type: string description: Masked OAuth client secret. If not set, empty string will be returned. authorizationUrl: type: string description: Authorization URL of the OAuth provider. tokenUrl: type: string description: Token URL of the OAuth provider. tokenPrefix: type: string description: Optional token prefix that's used to make the API request. scopes: type: string description: Optional scopes of the OAuth client. redirectUri: type: string description: Redirect URI of the Pack. useDynamicClientRegistration: type: boolean description: Whether this Pack uses Dynamic Client Registration for OAuth. PackInvocationLog: x-schema-name: PackInvocationLog description: System logs of the invocations of the Pack. type: object required: - type - context additionalProperties: false properties: type: type: string enum: - invocation x-tsType: PackLogType.Invocation context: $ref: '#/components/schemas/PackLogContext' cacheHit: type: boolean description: True if the formula returned a prior result without executing. duration: type: number description: Duration of the formula exeuction in miliseconds. error: description: Error info if this invocation resulted in an error. type: object required: - message additionalProperties: false properties: message: type: string stack: type: string PackConnectionGoogleServiceAccountCredentials: x-schema-name: PackConnectionGoogleServiceAccountCredentials type: object required: - type - serviceAccountKey additionalProperties: false properties: type: type: string enum: - googleServiceAccount x-tsType: PackConnectionType.GoogleServiceAccount serviceAccountKey: type: string PackSourceCodeInfo: x-schema-name: PackSourceCodeInfo description: Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete. type: object required: - files additionalProperties: false properties: files: type: array items: $ref: '#/components/schemas/PackSourceCode' PackSummary: x-schema-name: PackSummary description: Summary of a Pack. type: object additionalProperties: false required: - id - name - description - shortDescription - workspaceId - categories properties: id: type: number description: ID of the Pack. example: 1003 logoUrl: type: string format: url description: The link to the logo of the Pack. coverUrl: type: string format: url description: The link to the cover photo of the Pack. exampleImages: type: array description: The example images for the Pack. items: $ref: '#/components/schemas/PackImageFile' agentImages: type: array description: The agent images for the Pack. items: $ref: '#/components/schemas/PackImageFile' workspaceId: type: string description: The parent workspace for the Pack. example: ws-asdf categories: type: array description: Publishing categories associated with this Pack. items: $ref: '#/components/schemas/PublishingCategory' certified: type: boolean description: Denotes if the Pack is certified by Superhuman. certifiedAgent: type: boolean description: Denotes if the Pack is certified by Grammarly to be optimized for agent usage. sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' packEntrypoints: type: array description: Pack entrypoints where this Pack is available items: $ref: '#/components/schemas/PackEntrypoint' verifiedVersion: type: string description: The latest released Pack version that has been verified (approved) for use. For agent Packs, this is the most recent release that passed review. For non-agent Packs or legacy releases, this is the most recent release. example: 1.0.0 name: type: string description: The name of the Pack. example: Cool Geometry Formulas maxLength: 128 description: type: string description: The full description of the Pack. example: This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. example: Calculate cool geometric formulas like surface area. maxLength: 256 agentShortDescription: type: string description: A short description for the Pack as an agent. example: Chat with a tool that can calculate cool geometric formulas like surface area. maxLength: 256 agentDescription: type: string description: A full description for the Pack as an agent. example: Chat with a comprehensive tool that can calculate cool geometric formulas like surface area, volume, and other mathematical operations. This agent can help with complex calculations and provide detailed explanations. x-allow-empty: true maxLength: 8192 supportEmail: type: string description: A contact email for the Pack. example: user@email.com maxLength: 512 termsOfServiceUrl: type: string format: url description: A Terms of Service URL for the Pack. maxLength: 512 privacyPolicyUrl: type: string format: url description: A Privacy Policy URL for the Pack. maxLength: 512 PackImageFile: x-schema-name: PackImageFile description: A Pack image file. type: object additionalProperties: false required: - filename - imageUrl - assetId properties: filename: type: string description: The name of the image file. imageUrl: type: string format: url description: The URL to the image file. assetId: type: string description: The asset id of the Pack's image. altText: type: string description: The alt text for the image. mimeType: type: string description: The media type of the image. example: image/jpeg CancelPackReviewResponse: x-schema-name: CancelPackReviewResponse description: Response confirming the Pack review was canceled type: object additionalProperties: false properties: {} PackOAuth2ClientCredentialsLocation: x-schema-name: PackOAuth2ClientCredentialsLocation description: Location of including OAuth2 client credentials in a request. type: string enum: - automatic - body - header x-tsEnumNames: - Automatic - Body - Header PackConnectionCustomMetadata: x-schema-name: PackConnectionCustomMetadata type: object required: - type - params - domain - presetKeys additionalProperties: false properties: type: type: string enum: - custom x-tsType: PackConnectionType.Custom params: type: array description: An array of objects containing the parameter key and masked value. items: type: object required: - key - maskedValue additionalProperties: false properties: key: type: string maskedValue: type: string domain: type: string description: The domain corresponding to the pre-authorized network domain in the Pack. presetKeys: type: array description: An array containing the keys of parameters specified by the authentication config. items: type: string GroupedPackLog: x-schema-name: GroupedPackLog description: A record of grouped Pack log. oneOf: - $ref: '#/components/schemas/GroupedPackInvocationLog' - $ref: '#/components/schemas/GroupedPackAuthLog' discriminator: propertyName: type mapping: invocation: '#/components/schemas/GroupedPackInvocationLog' auth: '#/components/schemas/GroupedPackAuthLog' AccessType: x-schema-name: AccessType description: Type of access. type: string enum: - readonly - write - comment - none x-tsEnumNames: - ReadOnly - Write - Comment - None FreePackPlanPricing: x-schema-name: FreePackPlanPricing description: Pricing used when workspaces can subscribe to the Pack for free. type: object required: - type additionalProperties: false properties: type: type: string enum: - Free x-tsType: PackPlanPricingType.Free PackPermissionList: x-schema-name: PackPermissionList description: List of Pack permissions. type: object required: - items - permissionUsers additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackPermission' permissionUsers: type: array items: $ref: '#/components/schemas/UserSummary' ListPackCategoriesResponse: x-schema-name: ListPackCategoriesResponse description: Confirmation of successfully retrieving Pack categories. type: object required: - categories additionalProperties: false properties: categories: type: array description: The names of categories associated with a Pack. items: $ref: '#/components/schemas/PublishingCategory' DocPackConnectionWriteAccess: x-schema-name: DocPackConnectionWriteAccess description: Who in the doc has access to perform actions using the connection. type: string enum: - Anyone - Self - None x-tsEnumNames: - Anyone - Self - None PackGrammarlyInstitutionPrincipal: x-schema-name: PackGrammarlyInstitutionPrincipal type: object required: - type - grammarlyInstitutionId additionalProperties: false properties: type: type: string enum: - grammarlyInstitution x-tsType: PackPrincipalType.GrammarlyInstitution grammarlyInstitutionId: type: integer format: int64 minimum: 1 NextPackVersionInfo: x-schema-name: NextPackVersionInfo description: Information indicating the next Pack version definition. type: object required: - nextVersion - findings - findingDetails additionalProperties: false properties: nextVersion: type: string description: The next valid version for the Pack. example: 2.1.0 findings: type: array deprecated: true items: type: string description: List of changes from the previous version. findingDetails: type: array items: type: object additionalProperties: false required: - finding - path properties: finding: type: string path: type: string Principal: x-schema-name: Principal description: Metadata about a principal. oneOf: - $ref: '#/components/schemas/EmailPrincipal' - $ref: '#/components/schemas/GroupPrincipal' - $ref: '#/components/schemas/DomainPrincipal' - $ref: '#/components/schemas/WorkspacePrincipal' - $ref: '#/components/schemas/AnyonePrincipal' discriminator: propertyName: type mapping: email: '#/components/schemas/EmailPrincipal' group: '#/components/schemas/GroupPrincipal' domain: '#/components/schemas/DomainPrincipal' workspace: '#/components/schemas/WorkspacePrincipal' anyone: '#/components/schemas/AnyonePrincipal' NextPageToken: description: If specified, an opaque token used to fetch the next page of results. type: string example: eyJsaW1pd PackListingInstallContextType: x-schema-name: PackListingInstallContextType description: Type of context in which a Pack is being installed. type: string enum: - workspace - doc x-tsEnumNames: - Workspace - Doc IngestionParentItem: x-schema-name: IngestionParentItem description: An ingestion parent item and its execution state (either full or incremental). type: object required: - completionTimestamp - creationTimestamp - errorMessage - executionType - ingestionExecutionId - ingestionName - parentItemId - startTimestamp additionalProperties: false properties: attemptNumber: type: number description: The attempt number of the ingestion child execution. completionTimestamp: type: number description: Completion time of the ingestion child execution in seconds since epoch. errorMessage: type: string nullable: true executionType: $ref: '#/components/schemas/IngestionChildExecutionType' ingestionChildExecutionIndex: type: number description: Current execution index for this parent item's child execution. ingestionExecutionId: type: string description: The ID of the ingestion child execution. ingestionName: type: string description: The name of the ingestion child execution. ingestionStatus: $ref: '#/components/schemas/IngestionStatus' parentItemId: type: string description: The ID of the parent item. startTimestamp: type: number description: Start time of the ingestion child execution in seconds since epoch. rowCount: type: number description: The number of rows processed so far in the current ingestion child execution. latestCheckpointTimestamp: type: number description: The timestamp of the latest checkpoint of the ingestion child execution. BundledPackPlanPricing: x-schema-name: BundledPackPlanPricing description: Pricing used when workspaces have access to the Pack for free if their workspace is at least the given tier. type: object required: - type - minimumFeatureSet additionalProperties: false properties: type: type: string enum: - BundledWithTier x-tsType: PackPlanPricingType.BundledWithTier minimumFeatureSet: $ref: '#/components/schemas/PaidFeatureSet' IngestionBatchExecution: x-schema-name: IngestionBatchExecution description: An ingestion batch execution. type: object required: - completionTimestamp - creationTimestamp - errorMessage - executionType - fullExecutionId - ingestionExecutionId - ingestionId - ingestionName - ingestionStatuses - startTimestamp additionalProperties: false properties: completionTimestamp: type: number description: Completion time of the ingestion batch execution in seconds since epoch. creationTimestamp: type: number description: Creation time of the ingestion batch execution in seconds since epoch. dynamicLabel: type: string description: The label of the dynamic URL of the ingestion, if any. dynamicUrl: type: string description: The dynamic URL of the ingestion. executionType: $ref: '#/components/schemas/IngestionExecutionType' fullExecutionId: type: string description: The ID of the full ingestion execution. ingestionExecutionId: type: string description: The ID of the ingestion batch execution. ingestionId: type: string description: The ID of the ingestion. ingestionName: type: string description: The name of the ingestion. ingestionStatusCounts: type: object additionalProperties: type: integer description: Histogram of IngestionStatus of child executions (even if there's only 1, non-crawled execution) as enum values. example: COMPLETED: 12 FAILED: 5 STARTED: 4 lastFinishedFullWorkflowExecutionId: type: string format: uuid description: The ID of the last full workflow execution that finished. lastFinishedIncrementalWorkflowExecutionId: type: string format: uuid description: The ID of the last incremental workflow execution that finished. latestFullWorkflowExecutionId: type: string format: uuid description: The ID of the latest full workflow execution. latestIncrementalWorkflowExecutionId: type: string format: uuid description: The ID of the latest incremental workflow execution. latestIngestionSequenceId: type: string format: uuid description: The ID of the latest full execution. liveIngestionSequenceId: type: string format: uuid description: The ID of the full execution that generated the currently live data. parentSyncTableIngestionId: type: string description: The ID of the parent sync tableingestion, if any. startTimestamp: type: number description: Start time of the ingestion batch execution in seconds since epoch. totalRowCount: type: number description: The total number of rows processed in the ingestion batch execution. AddPackCategoryRequest: x-schema-name: AddPackCategoryRequest description: Payload for adding a Pack Category. type: object required: - categoryName additionalProperties: false properties: categoryName: type: string description: Name of the publishing category. example: Project management MakerSummary: x-schema-name: MakerSummary description: Summary about a maker type: object required: - name additionalProperties: false properties: name: type: string description: Name of the maker. example: John Doe pictureLink: type: string format: url description: Browser-friendly link to the maker's avatar image. example: https://cdn.coda.io/avatars/default_avatar.png slug: type: string description: Maker profile identifier for the maker. jobTitle: type: string description: Job title for maker. employer: type: string description: Employer for maker. description: type: string description: Description for the maker. Workspace: x-schema-name: Workspace description: Info about a Superhuman Docs workspace. type: object required: - type - id - name properties: type: type: string description: The type of this resource. enum: - workspace x-tsType: Type.Workspace id: type: string description: ID of the Superhuman Docs workspace. example: ws-1Ab234 name: type: string description: Name of the workspace. example: example.com featureSet: $ref: '#/components/schemas/FeatureSet' autoJoinDomains: type: array items: type: string format: domain description: When enabled for the org new users matching the specified auto-join domains will get added as workspace members. example: - example.com truncatedAutoJoinDomains: type: boolean description: Whether the auto-join domains list is truncated; if true use a paginated query to fetch all domains. example: false numDocMakerAdmins: type: integer description: Number of Doc Maker Admins in the workspace. example: 3 numDocMakers: type: integer description: Number of Doc Makers in the workspace. example: 13 numEditors: type: integer description: Number of Editors in the workspace. example: 5 PatchPackSystemConnectionRequest: x-schema-name: PatchPackSystemConnectionRequest description: The request to patch Pack system connection credentials. oneOf: - $ref: '#/components/schemas/PackConnectionHeaderPatch' - $ref: '#/components/schemas/PackConnectionMultiHeaderPatch' - $ref: '#/components/schemas/PackConnectionUrlParamPatch' - $ref: '#/components/schemas/PackConnectionHttpBasicPatch' - $ref: '#/components/schemas/PackConnectionCustomPatch' - $ref: '#/components/schemas/PackConnectionOauth2ClientCredentialsPatch' - $ref: '#/components/schemas/PackConnectionGoogleServiceAccountPatch' - $ref: '#/components/schemas/PackConnectionAwsAssumeRolePatch' - $ref: '#/components/schemas/PackConnectionAwsAccessKeyPatch' discriminator: propertyName: type mapping: header: '#/components/schemas/PackConnectionHeaderPatch' multiHeader: '#/components/schemas/PackConnectionMultiHeaderPatch' urlParam: '#/components/schemas/PackConnectionUrlParamPatch' httpBasic: '#/components/schemas/PackConnectionHttpBasicPatch' custom: '#/components/schemas/PackConnectionCustomPatch' oauth2ClientCredentials: '#/components/schemas/PackConnectionOauth2ClientCredentialsPatch' googleServiceAccount: '#/components/schemas/PackConnectionGoogleServiceAccountPatch' awsAssumeRole: '#/components/schemas/PackConnectionAwsAssumeRolePatch' awsAccessKey: '#/components/schemas/PackConnectionAwsAccessKeyPatch' PackConnectionCustomCredentials: x-schema-name: PackConnectionCustomCredentials type: object required: - type - params additionalProperties: false properties: type: type: string enum: - custom x-tsType: PackConnectionType.Custom params: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string PackVersion: x-schema-name: PackVersion description: Details about a Pack version. type: object additionalProperties: false required: - packId - buildNotes - createdAt - creationUserLoginId - packVersion properties: packId: type: number description: ID of the Pack. example: 1003 buildNotes: type: string description: Developer notes. example: Adding a new formula. createdAt: type: string format: date-time description: Timestamp for when the version was created. example: '2018-04-11T00:18:57.946Z' creationUserLoginId: type: string description: The login ID of creation user of the Pack version. example: api@example.com releaseId: type: number description: The release number of the Pack version if it has one. example: 2 packVersion: type: string description: The semantic format of the Pack version. example: 1.0.3 sdkVersion: type: string description: What Packs SDK version was this version built on. example: 1.5.1 source: $ref: '#/components/schemas/PackSource' PackOrganizationAccessForCodaBrain: x-schema-name: PackOrganizationAccessForCodaBrain description: Describes restrictions that a user's organization has placed on a Pack for Coda Brain ingestions type: object required: - canRequestAccess - hasRequestedAccess - requiresConfiguration additionalProperties: false properties: canRequestAccess: type: boolean hasRequestedAccess: type: boolean requiresConfiguration: type: boolean allowedConfigurations: type: array items: $ref: '#/components/schemas/PackConfigurationEntry' allowedPackIds: type: array items: type: number AddPackCategoryResponse: x-schema-name: AddPackCategoryResponse description: Confirmation of successfully adding a Pack category. type: object additionalProperties: false properties: {} PackMcpLog: x-schema-name: PackMcpLog description: Pack log generated by an MCP (Model Context Protocol) operation. type: object required: - type - context additionalProperties: false properties: type: type: string enum: - mcp x-tsType: PackLogType.Mcp context: $ref: '#/components/schemas/PackLogContext' message: type: string description: A descriptive message about the MCP operation. error: description: Error info if this invocation resulted in an error. type: object required: - message additionalProperties: false properties: message: type: string stack: type: string PackSummaryList: x-schema-name: PackSummaryList description: List of Pack summaries. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackSummary' nextPageToken: $ref: '#/components/schemas/nextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/nextPageLink' - type: string example: https://docs.superhuman.com/apis/v1/packs?pageToken=xyz PackConnectionCustomPatch: x-schema-name: PackConnectionCustomPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - custom x-tsType: PackConnectionType.Custom paramsToPatch: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string InternalAccessPrincipal: type: object required: - type - internalAccessType additionalProperties: false properties: type: type: string description: The type of this principal. enum: - internalAccess x-tsType: PrincipalType.InternalAccess internalAccessType: type: string description: The type of internal access (e.g., support). example: support AddPackMakerResponse: x-schema-name: AddPackMakerResponse description: Confirmation of successfully adding a Pack maker. type: object additionalProperties: false properties: {} ListPackMakersResponse: x-schema-name: ListPackMakersResponse description: Confirmation of successfully retrieving Pack makers. type: object required: - makers additionalProperties: false properties: makers: type: array items: $ref: '#/components/schemas/Maker' PackPrincipal: x-schema-name: PackPrincipal description: Metadata about a Pack principal. oneOf: - $ref: '#/components/schemas/PackUserPrincipal' - $ref: '#/components/schemas/PackWorkspacePrincipal' - $ref: '#/components/schemas/PackGlobalPrincipal' - $ref: '#/components/schemas/PackNomosOrganizationPrincipal' - $ref: '#/components/schemas/PackGroupPrincipal' - $ref: '#/components/schemas/PackGrammarlyInstitutionPrincipal' discriminator: propertyName: type mapping: user: '#/components/schemas/PackUserPrincipal' workspace: '#/components/schemas/PackWorkspacePrincipal' global: '#/components/schemas/PackGlobalPrincipal' nomosOrganization: '#/components/schemas/PackNomosOrganizationPrincipal' group: '#/components/schemas/PackGroupPrincipal' grammarlyInstitution: '#/components/schemas/PackGrammarlyInstitutionPrincipal' CreatePackReviewRequest: x-schema-name: CreatePackReviewRequest description: Request to create a Pack review type: object additionalProperties: false properties: packVersion: type: string description: Pack version to review (for code reviews) releaseNotes: type: string maxLength: 8192 description: Release notes for this version (used when Pack is approved and released) PackAssetUploadCompleteResponse: x-schema-name: PackAssetUploadCompleteResponse description: Response for noting a Pack asset upload is complete. type: object additionalProperties: false required: - requestId - assetId properties: requestId: type: string description: An arbitrary unique identifier for this request. example: abc-123-def-456 assetId: type: string description: An identifier of this uploaded asset. example: e23fcb5e564f08b71183d424c2c380c0 Maker: x-schema-name: Maker description: Info about the maker type: object required: - name - loginId additionalProperties: false properties: name: type: string description: Name of the maker. example: John Doe pictureLink: type: string format: url description: Browser-friendly link to the maker's avatar image. example: https://cdn.coda.io/avatars/default_avatar.png slug: type: string description: Maker profile identifier for the maker. jobTitle: type: string description: Job title for maker. employer: type: string description: Employer for maker. description: type: string description: Description for the maker. loginId: type: string description: Email address of the user. example: user@example.com PackRateLimit: x-schema-name: PackRateLimit description: Rate limit in Pack settings. type: object additionalProperties: false required: - intervalSeconds - operationsPerInterval properties: intervalSeconds: type: integer description: The rate limit interval in seconds. example: 3600 minimum: 1 maximum: 86400 operationsPerInterval: type: integer description: The maximum number of Pack operations that can be performed in a given interval. example: 20 minimum: 0 PackInvocationLogDetails: x-schema-name: PackInvocationLogDetails description: Details for Pack invocation logs type: object required: - type additionalProperties: false properties: type: type: string enum: - invocation x-tsType: PackLogType.Invocation result: type: object required: - stringVal - int64Val - doubleVal - objectVal - boolVal - dateVal additionalProperties: false properties: stringVal: type: string int64Val: type: number doubleVal: type: number objectVal: type: string boolVal: type: boolean dateVal: type: number resultDetail: type: string description: Supplementary information about the result. continuationJson: type: string description: Only used by sync invocations. completionJson: type: string description: Only used by sync invocations. deletedItemIdsJson: type: string description: Only used by sync invocations. permissionsContextJson: type: string description: Only used by sync invocations. PackListingDetail: x-schema-name: PackListingDetail description: A detailed Pack listing. type: object additionalProperties: false required: - packId - packVersion - name - shortDescription - description - logoUrl - logo - discoverability - categories - makers - userAccess - externalMetadataUrl - sdkVersion - packCategoryType properties: packId: type: number description: ID of the Pack. example: 1003 packVersion: type: string description: The version of the Pack. example: 1.0.3 releaseId: type: number description: The current release number of the Pack if released, otherwise undefined. example: 2 lastReleasedAt: type: string format: date-time description: The timestamp of the latest release of this Pack. example: '2018-04-11T00:18:57.946Z' logoUrl: type: string format: url description: The link to the logo of the Pack. deprecated: true logo: $ref: '#/components/schemas/PackImageFile' coverUrl: type: string format: url description: The link to the cover photo of the Pack. deprecated: true cover: $ref: '#/components/schemas/PackImageFile' exampleImages: type: array items: $ref: '#/components/schemas/PackImageFile' description: The example images for the Pack. agentImages: type: array items: $ref: '#/components/schemas/PackImageFile' description: The agent images for the Pack. name: type: string description: The name of the Pack. example: Cool Geometry Formulas description: type: string description: The full description of the Pack. example: This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. example: Calculate cool geometric formulas like surface area. agentShortDescription: type: string description: A short description for the Pack as an agent. example: Chat with a tool that can calculate cool geometric formulas like surface area. agentDescription: type: string description: A full description for the Pack as an agent. example: Chat with a comprehensive tool that can calculate cool geometric formulas like surface area, volume, and other mathematical operations. This agent can help with complex calculations and provide detailed explanations. supportEmail: type: string description: A contact email for the Pack. example: user@email.com termsOfServiceUrl: type: string format: url description: A Terms of Service URL for the Pack. privacyPolicyUrl: type: string format: url description: A Privacy Policy URL for the Pack. categories: type: array description: Publishing Categories associated with this Pack. items: $ref: '#/components/schemas/PublishingCategory' makers: type: array description: Makers associated with this Pack. items: $ref: '#/components/schemas/MakerSummary' certified: type: boolean description: Denotes if the Pack is certified by Superhuman. certifiedAgent: type: boolean description: Denotes if the Pack is certified by Superhuman to be optimized for agent usage. minimumFeatureSet: $ref: '#/components/schemas/FeatureSet_2' unrestrictedFeatureSet: $ref: '#/components/schemas/FeatureSet_2' externalMetadataUrl: type: string description: The URL where complete metadata about the contents of the Pack version can be downloaded. example: https://codahosted.io/packs/12345/1.2.3/metadata/0c892064aa5cb.json standardPackPlan: $ref: '#/components/schemas/StandardPackPlan' bundledPackPlan: $ref: '#/components/schemas/BundledPackPlan' sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' sdkVersion: type: string description: What Packs SDK version was this version built on. example: 1.5.1 packCategoryType: $ref: '#/components/schemas/PackCategoryType' discoverability: $ref: '#/components/schemas/PackDiscoverability' userAccess: $ref: '#/components/schemas/PackUserAccess' codaHelpCenterUrl: type: string description: The URL of a Superhuman Docs Help Center article with documentation about the Pack. This will only exist for select Superhuman Docs-authored Packs. configuration: $ref: '#/components/schemas/PackConfigurationEntry' PackConnectionHttpBasicPatch: x-schema-name: PackConnectionHttpBasicPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - httpBasic x-tsType: PackConnectionType.HttpBasic username: type: string password: type: string x-allow-empty: true PackAgentRuntimeLog: x-schema-name: PackAgentRuntimeLog description: Pack log generated by an executing agent runtime. type: object required: - type - context - turnType additionalProperties: false properties: type: type: string enum: - agentRuntime x-tsType: PackLogType.AgentRuntime context: $ref: '#/components/schemas/PackLogContext' turnType: type: string description: The type of LLM agent turn that this log is for. durationMs: type: number description: The duration of the turn in milliseconds. name: type: string description: The name of the turn target. model: type: string description: The model used for the turn. tokenUsage: type: string description: The token usage for the turn. instructions: type: string description: The instructions for the turn. fromAgent: type: string description: The name of the agent that initiated the turn. toAgent: type: string description: The name of the agent that received the turn. PackVersionDiffs: x-schema-name: PackVersionDiffs description: Info about the diff between two Pack versions. type: object required: - findings - findingDetails additionalProperties: false properties: findings: type: array deprecated: true items: type: string description: List of changes from the previous version to the next version. findingDetails: type: array items: type: object additionalProperties: false required: - finding - path properties: finding: type: string path: type: string Doc: x-schema-name: Doc description: Info about a document. type: object required: - type - docType - id - name - href - browserLink - folderId - workspaceId properties: type: type: string description: The type of this resource. enum: - doc x-tsType: Type.Doc docType: $ref: '#/components/schemas/DocType' id: type: string description: ID of the document. example: AbCDeFGH name: type: string description: Name of the doc. example: Product Launch Hub icon: type: string description: Name of the icon. example: exclamation-circle-filled keyAccessRevoked: type: boolean description: True when this doc's encryption key can't be unwrapped (revoked or missing), so its name can't be decrypted. example: false href: type: string format: url description: API link to the document. example: https://docs.superhuman.com/apis/admin/v1/docs/AbCDeFGH browserLink: type: string format: url description: Browser-friendly link to the document. example: https://docs.superhuman.com/d/_dAbCDeFGH folderId: type: string description: ID of the document's folder. example: fl-es129308 workspaceId: type: string description: ID of the document's workspace. example: ws-sdfmsdf9 owner: type: string format: email description: Email address of the doc owner example: april@example.com ownerName: type: string description: Name of the doc owner example: April Jane createdAt: type: string format: date-time description: Timestamp for when the doc was created. example: '2018-04-11T00:18:57.946Z' updatedAt: type: string format: date-time description: Timestamp for when the doc was last modified. example: '2018-04-11T00:18:57.946Z' acl: type: array items: $ref: '#/components/schemas/Permission' truncatedAcl: type: boolean description: True if the inline ACL field was truncated; use a paginated ACL query to fetch all permissions. aclSummary: $ref: '#/components/schemas/PermissionsSummary' searchHit: $ref: '#/components/schemas/DocSearchHit' docUsersLast90Days: deprecated: true type: number description: Deprecated, use documentAnalytics instead. example: 42 isDeleted: type: boolean description: True if the doc has been deleted. example: false installedPackCount: type: number description: Number of Packs installed in the doc. example: 3 discoverableViaWeb: type: boolean description: True if the doc is published and discoverable via the web. example: true documentAnalytics: $ref: '#/components/schemas/DocumentAnalytics' PackRelease: x-schema-name: PackRelease description: Details about a Pack release. type: object additionalProperties: false required: - packId - releaseId - releaseNotes - createdAt - packVersion - sdkVersion properties: packId: type: number description: ID of the Packs. example: 1003 releaseNotes: type: string description: Developer notes. example: The first release. createdAt: type: string format: date-time description: Timestamp for when the release was created. example: '2018-04-11T00:18:57.946Z' releaseId: type: number description: The release number of the Pack version if it has one. example: 2 packVersion: type: string description: The semantic format of the Pack version. example: 1.0.3 sdkVersion: type: string description: What Packs SDK version was this version built on. example: 1.5.1 IngestionPackReleaseChannel: x-schema-name: IngestionPackReleaseChannel description: Live or Latest version of Pack type: string enum: - LIVE - LATEST x-tsEnumNames: - Live - Latest PermissionCount: x-schema-name: PermissionCount description: Count of permissions. oneOf: - $ref: '#/components/schemas/ExactPermissionCount' - $ref: '#/components/schemas/MinPermissionCount' discriminator: propertyName: type mapping: exactCount: '#/components/schemas/ExactPermissionCount' minCount: '#/components/schemas/MinPermissionCount' SortDirection: x-schema-name: SortDirection description: Direction of a sort for a table or view. type: string enum: - ascending - descending x-tsEnumNames: - Ascending - Descending PackSourceCodeUploadInfo: x-schema-name: PackSourceCodeUploadInfo description: Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete. type: object required: - uploadUrl - uploadedPathName - headers additionalProperties: false properties: uploadUrl: type: string format: url description: A signed URL to be used for uploading a Pack source code. example: https://coda-us-west-2-prod-packs-upload.s3-accelerate.amazonaws.com/packUploads/123/1/main.ts uploadedPathName: type: string description: An endpoint to mark the upload as complete. example: /packs/123/versions/1/sourceCode/uploadComplete headers: type: object additionalProperties: type: string description: Key-value pairs of authorization headers to include in the upload request. example: '{"header1": "value1"}' PackConnectionHttpBasicCredentials: x-schema-name: PackConnectionHttpBasicCredentials type: object required: - type - username additionalProperties: false properties: type: type: string enum: - httpBasic x-tsType: PackConnectionType.HttpBasic username: type: string password: type: string x-allow-empty: true PackListingDraftInputData: x-schema-name: PackListingDraftInputData description: Input data for creating or updating a Pack listing draft. Images only require assetId and filename; the server resolves the full image URL. type: object additionalProperties: false properties: name: type: string description: The name of the Pack. maxLength: 128 description: type: string description: The full description of the Pack. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. maxLength: 256 logo: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' cover: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' exampleImages: type: array nullable: true items: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' agentImages: type: array nullable: true items: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' categoryIds: type: array items: type: string supportEmail: type: string nullable: true maxLength: 512 termsOfServiceUrl: type: string format: url nullable: true maxLength: 512 privacyPolicyUrl: type: string format: url nullable: true maxLength: 512 sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' agentShortDescription: type: string nullable: true maxLength: 256 agentDescription: type: string nullable: true maxLength: 8192 additionalInformation: $ref: '#/components/schemas/PackListingAdditionalInformation' PublishingCategory: x-schema-name: PublishingCategory description: Info about a publishing category type: object required: - categoryId - categoryName additionalProperties: false properties: categoryId: type: string description: The ID for this category. example: aBCdEFg categoryName: type: string description: The name of the category. example: Project management categorySlug: type: string description: The URL identifier of the category. example: project-management PackAssetUploadInfo: x-schema-name: PackAssetUploadInfo description: Information indicating where to upload the Pack asset, and an endpoint to mark the upload as complete. type: object required: - uploadUrl - packAssetUploadedPathName - headers additionalProperties: false properties: uploadUrl: type: string format: url description: A signed URL to be used for uploading a Pack asset. example: https://coda-us-west-2-prod-blobs-upload.s3-accelerate.amazonaws.com/packs/123/assets/logo/e23fcb5e564f08b71183d424c2c380c0 packAssetUploadedPathName: type: string description: An endpoint to mark the upload as complete. example: /packs/123/assets/e23fcb5e564f08b71183d424c2c380c0 headers: type: object additionalProperties: type: string description: Key-value pairs of authorization headers to include in the upload request. example: '{"header1": "value1"}' PackReviewStatus: x-schema-name: PackReviewStatus description: The status of a Pack review type: string enum: - pending - approved - denied - canceled - superseded x-tsEnumNames: - Pending - Approved - Denied - Canceled - Superseded DomainPrincipal: type: object required: - domain - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - domain x-tsType: PrincipalType.Domain domain: type: string description: Domain for the principal. example: domain.com DocType: x-schema-name: DocType type: string enum: - doc - form - template x-tsEnumNames: - Doc - Form - Template UpdatePackRequest: x-schema-name: UpdatePackRequest description: Payload for updating a Pack. type: object additionalProperties: false properties: overallRateLimit: x-schema-name: PackRateLimit description: Rate limit in Pack settings. type: object additionalProperties: false required: - intervalSeconds - operationsPerInterval properties: intervalSeconds: type: integer description: The rate limit interval in seconds. example: 3600 minimum: 1 maximum: 86400 operationsPerInterval: type: integer description: The maximum number of Pack operations that can be performed in a given interval. example: 20 minimum: 0 nullable: true perConnectionRateLimit: x-schema-name: PackRateLimit description: Rate limit in Pack settings. type: object additionalProperties: false required: - intervalSeconds - operationsPerInterval properties: intervalSeconds: type: integer description: The rate limit interval in seconds. example: 3600 minimum: 1 maximum: 86400 operationsPerInterval: type: integer description: The maximum number of Pack operations that can be performed in a given interval. example: 20 minimum: 0 nullable: true logo: x-schema-name: ImageFileForUpdatePackRequest description: Information about an image file for an update Pack request. type: object additionalProperties: false required: - assetId - filename properties: assetId: type: string description: The asset id of the Pack's image, returned by [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete) endpoint. filename: type: string description: The filename for the image. mimeType: type: string description: The media type of the image being sent. example: image/jpeg nullable: true cover: x-schema-name: ImageFileForUpdatePackRequest description: Information about an image file for an update Pack request. type: object additionalProperties: false required: - assetId - filename properties: assetId: type: string description: The asset id of the Pack's image, returned by [`#PackAssetUploadComplete`](#operation/packAssetUploadComplete) endpoint. filename: type: string description: The filename for the image. mimeType: type: string description: The media type of the image being sent. example: image/jpeg nullable: true exampleImages: type: array description: The example images for the Pack. nullable: true items: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' agentImages: type: array description: The agent images for the Pack. nullable: true items: $ref: '#/components/schemas/ImageFileForUpdatePackRequest' sourceCodeVisibility: $ref: '#/components/schemas/PackSourceCodeVisibility' nullable: true packEntrypoints: type: array description: Pack entrypoints where this Pack is available nullable: true minItems: 1 items: $ref: '#/components/schemas/PackEntrypoint' name: type: string description: The name of the Pack. example: Cool Geometry Formulas maxLength: 128 description: type: string description: The full description of the Pack. example: This Pack allows users to calculate the surface area and volume of a few common 3D shapes, like cubes and pyramids. maxLength: 8192 shortDescription: type: string description: A short version of the description of the Pack. example: Calculate cool geometric formulas like surface area. maxLength: 256 agentShortDescription: type: string description: A short description for the Pack as an agent. example: Chat with a tool that can calculate cool geometric formulas like surface area. maxLength: 256 agentDescription: type: string description: A full description for the Pack as an agent. example: Chat with a comprehensive tool that can calculate cool geometric formulas like surface area, volume, and other mathematical operations. This agent can help with complex calculations and provide detailed explanations. x-allow-empty: true maxLength: 8192 supportEmail: type: string description: A contact email for the Pack. example: user@email.com maxLength: 512 termsOfServiceUrl: type: string format: url description: A Terms of Service URL for the Pack. maxLength: 512 privacyPolicyUrl: type: string format: url description: A Privacy Policy URL for the Pack. maxLength: 512 UploadPackAssetRequest: x-schema-name: UploadPackAssetRequest description: Payload for a Pack asset upload. type: object additionalProperties: false required: - packAssetType - filename - mimeType - imageHash properties: packAssetType: $ref: '#/components/schemas/PackAssetType' imageHash: type: string description: The SHA-256 hash of the image to be uploaded. example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b mimeType: type: string description: The media type of the image being sent. example: image/jpeg filename: type: string example: image.jpg DeletePackListingDraftResponse: x-schema-name: DeletePackListingDraftResponse description: Response after deleting a Pack listing draft type: object additionalProperties: false PackNomosOrganizationPrincipal: x-schema-name: PackNomosOrganizationPrincipal type: object required: - type - nomosOrganizationId additionalProperties: false properties: type: type: string enum: - nomosOrganization x-tsType: PackPrincipalType.NomosOrganization nomosOrganizationId: type: string PackAuthLog: x-schema-name: PackAuthLog description: System logs of Pack authentication requests. type: object required: - type - context - path additionalProperties: false properties: type: type: string enum: - auth x-tsType: PackLogType.Auth context: $ref: '#/components/schemas/PackLogContext' path: type: string description: The request path. errorMessage: type: string description: The error message. errorStack: type: string description: The error stacktrace (internal only). EmailPrincipal: type: object required: - email - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - email x-tsType: PrincipalType.Email email: type: string description: Email for the principal. example: example@domain.com PackConnectionUrlParamMetadata: x-schema-name: PackConnectionUrlParamMetadata type: object required: - type - params - domain - presetKeys additionalProperties: false properties: type: type: string enum: - urlParam x-tsType: PackConnectionType.UrlParam params: type: array items: type: object required: - key - maskedValue additionalProperties: false properties: key: type: string maskedValue: type: string domain: type: string presetKeys: type: array items: type: string PackEntrypoint: x-schema-name: PackEntrypoint type: string enum: - go - docs x-tsEnumNames: - Go - Docs CreatePackInvitationResponse: x-schema-name: CreatePackInvitationResponse description: Confirmation of successfully creating a Pack invitation. type: object required: - invitationId additionalProperties: false properties: invitationId: type: string description: The ID of the invitation created. example: 550e8400-e29b-41d4-a716-446655440000 PermissionsSummary: x-schema-name: PermissionsSummary description: Summary of permissions. type: object required: - worldwideAccess - domainShares - workspaceShares - numGroupPermissions - numUserPermissions additionalProperties: false properties: worldwideAccess: $ref: '#/components/schemas/AccessType' domainShares: type: array items: type: string description: List of domains that have access workspaceShares: type: array items: type: string description: List of workspaces that have access numGroupPermissions: $ref: '#/components/schemas/PermissionCount' numUserPermissions: $ref: '#/components/schemas/PermissionCount' nextPageToken: description: If specified, an opaque token used to fetch the next page of results. type: string example: eyJsaW1pd AnyonePrincipal: type: object required: - type additionalProperties: false properties: type: type: string description: The type of this principal. enum: - anyone x-tsType: PrincipalType.Anyone FeatureSet: x-schema-name: FeatureSet deprecated: true description: Pricing plan associated with a workspace. type: string enum: - Free - Pro - Team - Enterprise x-tsEnumNames: - Free - Pro - Team - Enterprise PackInvitationWithPackList: x-schema-name: PackInvitationWithPackList description: List of Pack invitations with Pack metadata. type: object required: - items additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PackInvitationWithPack' nextPageToken: type: string nullable: true description: Token for fetching the next page of results nextPageLink: type: string format: url nullable: true description: URL for fetching the next page of results UserSummary: x-schema-name: UserSummary description: Summary about the user. type: object required: - name - loginId - type additionalProperties: false properties: name: type: string description: Name of the user. example: John Doe loginId: type: string description: Email address of the user. example: user@example.com type: type: string description: The type of this resource. enum: - user x-tsType: Type.User pictureLink: type: string format: url description: Browser-friendly link to the user's avatar image. example: https://cdn.coda.io/avatars/default_avatar.png PackConnectionAwsAccessKeyMetadata: x-schema-name: PackConnectionAwsAccessKeyMetadata type: object required: - type - service - maskedAccessKeyId - maskedSecretAccessKey additionalProperties: false properties: type: type: string enum: - awsAccessKey x-tsType: PackConnectionType.AwsAccessKey service: type: string maskedAccessKeyId: type: string maskedSecretAccessKey: type: string PackIngestionLifecycleLog: x-schema-name: PackIngestionLifecycleLog description: Pack log generated by an executing ingestion. type: object required: - type - context - message - level additionalProperties: false properties: type: type: string enum: - ingestionLifecycle x-tsType: PackLogType.IngestionLifecycle context: $ref: '#/components/schemas/PackLogContext' message: type: string description: The message that's passed into context.logger. example: The formula is called! level: $ref: '#/components/schemas/LogLevel' PackVersionUploadInfo: x-schema-name: PackVersionUploadInfo description: Information indicating where to upload the Pack version definition. type: object required: - uploadUrl - headers additionalProperties: false properties: uploadUrl: type: string description: A URL to be used for uploading a Pack version definition. example: https://coda-us-west-2-prod-packs-upload.s3.amazonaws.com/packs/123/versions/1.0.0 headers: type: object additionalProperties: type: string description: Key-value pairs of authorization headers to include in the upload request. example: '{"header1": "value1"}' PackConnectionHeaderCredentials: x-schema-name: PackConnectionHeaderCredentials type: object required: - type - token additionalProperties: false properties: type: type: string enum: - header x-tsType: PackConnectionType.Header token: type: string PackUserAccess: x-schema-name: PackUserAccess type: object description: The access capabilities the current user has for this Pack. example: '{"canEdit": false, "canTest": false, "canView": true, "canInstall": true}' required: - canEdit - canTest - canView - canInstall - canPurchase - requiresTrial - canConnectAccount additionalProperties: false properties: canEdit: type: boolean canTest: type: boolean canView: type: boolean canInstall: type: boolean canPurchase: type: boolean requiresTrial: type: boolean canConnectAccount: type: boolean organization: oneOf: - $ref: '#/components/schemas/PackOrganizationAccessForDocs' - $ref: '#/components/schemas/PackOrganizationAccessForCodaBrain' ingestionLimitSettings: $ref: '#/components/schemas/IngestionLimitSettings' PackListingAdditionalInformation: x-schema-name: PackListingAdditionalInformation description: Additional information saved with the Pack listing draft type: object additionalProperties: false properties: privacyCollectsPersonalInfo: type: boolean nullable: true description: Whether the agent or third-party partners collect personal information. privacyPersonalInfoCategories: type: array nullable: true items: type: string description: Categories of personal information collected by the agent. privacyDataUsagePurposes: type: array nullable: true items: type: string description: Purposes for which collected data is used by the agent or third-party partners. privacyDataCollectedBy: type: array nullable: true items: type: string description: Whether data is collected by the developer, a third party, or both. PackConnectionMultiHeaderPatch: x-schema-name: PackConnectionMultiHeaderPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - multiHeader x-tsType: PackConnectionType.MultiHeader tokensToPatch: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string WorkspacePrincipal: type: object required: - type - workspaceId additionalProperties: false properties: type: type: string description: The type of this principal. enum: - workspace x-tsType: PrincipalType.Workspace workspaceId: type: string description: WorkspaceId for the principal. example: ws-sdfmsdf9 PackGlobalPrincipal: x-schema-name: PackGlobalPrincipal type: object required: - type additionalProperties: false properties: type: type: string enum: - worldwide x-tsType: PackPrincipalType.Worldwide PackAgentRuntimeLogDetails: x-schema-name: PackAgentRuntimeLogDetails description: Details for Pack agent runtime logs type: object required: - type additionalProperties: false properties: type: type: string enum: - agentRuntime x-tsType: PackLogType.AgentRuntime input: type: string description: The input to the turn. output: type: string description: The output from the turn. PaidFeatureSet: x-schema-name: PaidFeatureSet description: Workspace feature set excluding free. type: string enum: - Pro - Team - Enterprise x-tsEnumNames: - Pro - Team - Enterprise HandlePackInvitationResponse: x-schema-name: HandlePackInvitationResponse description: Confirmation of successfully handling a Pack invitation. type: object additionalProperties: false properties: permissionId: type: string description: The ID of the permission that was created. Only returned when accepting the invitation. PackReviewAdditionalInformation: x-schema-name: PackReviewAdditionalInformation description: Additional information about the Pack review type: object additionalProperties: false properties: privacyCollectsPersonalInfo: type: boolean nullable: true description: Whether the agent or third-party partners collect personal information. privacyPersonalInfoCategories: type: array nullable: true items: type: string description: Categories of personal information collected by the agent. privacyDataUsagePurposes: type: array nullable: true items: type: string description: Purposes for which collected data is used by the agent or third-party partners. privacyDataCollectedBy: type: array nullable: true items: type: string description: Whether data is collected by the developer, a third party, or both. PackInvitationWithPack: x-schema-name: PackInvitationWithPack description: Pack invitation with Pack metadata. type: object required: - invitation - pack - makers - networkDomains additionalProperties: false properties: invitation: $ref: '#/components/schemas/PackInvitation' pack: $ref: '#/components/schemas/PackSummary' makers: type: array items: $ref: '#/components/schemas/Maker' networkDomains: type: array items: type: string description: Network domain of the Pack PackFeaturedDocRequestItem: x-schema-name: PackFeaturedDocRequestItem description: Item representing a featured doc in the update Pack featured docs request. type: object required: - url additionalProperties: false properties: url: type: string description: A URL to a doc. isPinned: type: boolean description: Whether or not the current doc should be pinned. RegisterPackVersionRequest: x-schema-name: RegisterPackVersionRequest description: Payload for registering a Pack version. type: object required: - bundleHash additionalProperties: false properties: bundleHash: type: string description: The SHA-256 hash of the file to be uploaded. example: f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b PackConnectionUrlParamPatch: x-schema-name: PackConnectionUrlParamPatch type: object required: - type additionalProperties: false properties: type: type: string enum: - urlParam x-tsType: PackConnectionType.UrlParam paramsToPatch: type: array items: type: object required: - key - value additionalProperties: false properties: key: type: string value: type: string NextPageLink: description: If specified, a link that can be used to fetch the next page of results. type: string format: url PackAccessTypes: x-schema-name: PackAccessTypes description: Access types for a Pack. additionalProperties: false type: array items: $ref: '#/components/schemas/PackAccessType' LogLevel: x-schema-name: LogLevel type: string enum: - error - warn - info - debug - trace - unknown x-tsEnumNames: - Error - Warn - Info - Debug - Trace - Unknown PackIngestionDebugLog: x-schema-name: PackIngestionDebugLog description: Pack log generated by an executing ingestion. Contains metadata helpful for debugging type: object required: - type - context - message - level additionalProperties: false properties: type: type: string enum: - ingestionDebug x-tsType: PackLogType.IngestionDebug context: $ref: '#/components/schemas/PackLogContext' message: type: string description: The message that's passed into context.logger. example: The formula is called! level: $ref: '#/components/schemas/LogLevel' DocPackConnectionList: x-schema-name: DocPackConnectionList description: List of connections linked to docs. type: object required: - items - href additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/DocPackConnection' href: type: string format: url description: API link to these results example: https://docs.superhuman.com/apis/admin/v1/organizations/{organizationId}/docs/packConnections nextPageToken: $ref: '#/components/schemas/NextPageToken' nextPageLink: allOf: - $ref: '#/components/schemas/NextPageLink' - type: string example: https://docs.superhuman.com/apis/admin/v1/organizations/{organizationId}/docs/packConnections?pageToken=eyJsaW1pd DocumentAnalytics: x-schema-name: DocumentAnalytics description: Metrics for a doc. type: object required: - numPages - numPageViewsLast90Days - numCollaboratorsLast90Days additionalProperties: false properties: lastActiveDate: type: string format: date-time description: Timestamp for when the doc was last accessed. example: '2018-04-11T00:18:57.946Z' numPages: type: number description: Number of pages in the doc. example: 3 numPageViewsLast90Days: type: number description: Number of page views in the last 90 days. example: 42 numCollaboratorsLast90Days: type: number description: Number of unique users that have viewed the doc in the last 90 days. example: 42 externallySharedUserDomains: type: array items: type: string format: email description: Domains of users external to the organization this doc is shared with. example: - gmail.com - outlook.com CreatePackInvitationRequest: x-schema-name: CreatePackInvitationRequest description: Payload for creating a Pack invitation. type: object required: - access - email additionalProperties: false properties: email: type: string description: Email address of the user to invite example: user@example.com access: $ref: '#/components/schemas/PackAccessType' parameters: invitationId: name: invitationId description: ID of a Pack invitation in: path required: true example: 550e8400-e29b-41d4-a716-446655440000 schema: type: string format: uuid packVersion: name: packVersion description: Semantic version of a Pack in: path required: true example: 1.2.3 schema: type: string agentInstanceId: name: agentInstanceId description: ID of the agent instance. in: path required: true example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid packId: name: packId description: ID of a Pack in: path required: true example: 123 schema: type: integer minimum: 1 docId: name: docId description: ID of the doc. in: path required: true example: AbCDeFGH schema: type: string direction: name: direction description: Direction to sort results in. in: query schema: $ref: '#/components/schemas/SortDirection' packCategories: name: packCategories in: query description: Filter Packs by one or more category types. required: false explode: false schema: type: array items: $ref: '#/components/schemas/PackCategoryType' limit_2: name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 25 basePackVersion: name: basePackVersion description: Semantic version of the previous Pack version. in: path required: true example: 1.2.3 schema: type: string packAssetType: name: packAssetType description: Pack asset type. in: path required: true schema: $ref: '#/components/schemas/PackAssetType' ingestionExecutionId: name: ingestionExecutionId description: ID of the ingestion execution. in: query required: false example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid packEntrypoint: name: packEntrypoint description: Entrypoint for which this Pack call is being made. Used to filter non relevant Packs in: query schema: $ref: '#/components/schemas/PackEntrypoint' permissionId: name: permissionId description: ID of a permission on a doc. in: path required: true example: AbCDeFGH schema: type: string packAssetId: name: packAssetId description: Unique identifier for a Pack asset. in: path required: true schema: type: string packAccessTypes: name: packAccessTypes description: Pack access types. in: query explode: false schema: $ref: '#/components/schemas/PackAccessTypes' onlyWorkspaceId: name: onlyWorkspaceId description: Use only this workspace (not all of a user's workspaces) to check for Packs shared via workspace ACL. in: query schema: type: string rootIngestionId: name: rootIngestionId description: ID of the root ingestion. in: path required: true example: a4e293c4-4a85-45a4-b2ba-7f305cba2703 schema: type: string format: uuid tenantId: name: tenantId description: ID of the tenant. in: path required: true example: org-LxmbD9y2EU schema: type: string organizationId: name: organizationId description: ID of the organization. in: path required: true example: org-AbCDeFGHIj schema: type: string limit: name: limit description: Maximum number of results to return in this query. in: query example: 10 schema: type: integer minimum: 1 default: 100 maximum: 500 parentWorkspaceIds: name: parentWorkspaceIds description: Filter to only Packs whose parent workspace is one of the given IDs. in: query explode: false schema: type: array items: type: string loginId: name: loginId description: Email of a Superhuman Docs user. in: path required: true example: api@example.com schema: type: string categoryName: name: categoryName description: Name of a publishing category in: path required: true example: Project management schema: type: string excludePublicPacks: name: excludePublicPacks description: Only get Packs shared with users/workspaces, not publicly. in: query schema: type: boolean targetPackVersion: name: targetPackVersion description: Semantic version of the new Pack version. in: path required: true example: 1.2.3 schema: type: string packIds: name: packIds description: Which Pack IDs to fetch. in: query explode: false schema: type: array items: type: integer certifiedAgentsOnly: name: certifiedAgentsOnly description: 'Only include Packs that are certified for agent use. Depending on server configuration, may also include Packs that the user is an admin of. ' in: query schema: type: boolean default: false pageToken: name: pageToken description: An opaque token used to fetch the next page of results. in: query example: eyJsaW1pd schema: type: string packReleaseId: name: packReleaseId description: ID of a Pack release in: path required: true example: 2 schema: type: integer minimum: 1 responses: NotFoundError: description: The resource could not be located with the current API token. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 404 statusMessage: type: string description: HTTP status message of the error. example: Not Found message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Not Found BadRequestError: description: The request parameters did not conform to expectations. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 400 statusMessage: type: string description: HTTP status message of the error. example: Bad Request message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Bad Request TooManyRequestsError: description: The client has sent too many requests. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 429 statusMessage: type: string description: HTTP status message of the error. example: Too Many Requests message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Too Many Requests BadRequestWithValidationErrors: description: The request parameters did not conform to expectations. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 400 statusMessage: type: string description: HTTP status message of the error. example: Bad Request message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Bad Request codaDetail: type: object description: Detail about why this request was rejected. additionalProperties: false properties: validationErrors: type: array items: $ref: '#/components/schemas/ValidationError' UnauthorizedError: description: The API token is invalid or has expired. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 401 statusMessage: type: string description: HTTP status message of the error. example: Unauthorized message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Unauthorized ForbiddenError: description: The API token does not grant access to this resource. content: application/json: schema: description: An HTTP error resulting from an unsuccessful request. required: - statusCode - statusMessage - message additionalProperties: false properties: statusCode: type: number description: HTTP status code of the error. example: 403 statusMessage: type: string description: HTTP status message of the error. example: Forbidden message: type: string description: Any additional context on the error, or the same as `statusMessage` otherwise. example: Forbidden securitySchemes: Bearer: description: 'The Superhuman Docs Admin API can be accessed using an API token, which can be obtained from [*My account*](https://docs.superhuman.com/account) in Superhuman Docs. This token should be specified by setting a header as follows. ```Authorization: Bearer ``` Keep your token safe, as anyone who gets access to it can access your account. Once a token is created it cannot be viewed or modified, so don''t lose it. ' type: http scheme: bearer bearerFormat: UUID x-tagGroups: - name: API Tokens tags: - API Tokens - name: Docs tags: - Docs - Doc Permissions - Doc Export - name: Doc Structure tags: - Pages - name: Events tags: - Events - name: Folders tags: - Folders - Folder Permissions - name: Groups tags: - Groups - name: Import tags: - Preferences - name: LegalHolds tags: - LegalHolds - name: Organizations tags: - Organizations - Organization Users - Pack Controls - Pack Configurations - name: Packs tags: - Packs - name: Webhooks tags: - Webhooks - name: Workspaces tags: - Workspaces - Workspace Users