The identity and technical contract details declared by the specification.
SetPackSystemConnectionRequest
object
The request to set Pack system connection credentials.
1 property
1 required
CreatePackVersionResponse
object
Confirmation of successful Pack version creation.
1 property
PackConnectionCustomMetadata
object
4 properties
4 required
UpsertPackListingDraftRequest
object
Request to create or update a Pack listing draft
1 property
1 required
DocReference
object
Reference to a document.
4 properties
4 required
GroupedPackLog
A record of grouped Pack log.
DeleteUserPackPermissionsResponse
object
Confirmation of successfully deleting a user's permissions for a Pack.
PackInvocationLog
object
System logs of the invocations of the Pack.
5 properties
2 required
PackVersionDiffs
object
Info about the diff between two Pack versions.
2 properties
2 required
PacksSortBy
string
Determines how the Packs returned are sorted.
PackOAuth2ClientCredentialsLocation
string
Location of including OAuth2 client credentials in a request.
AddPackPermissionRequest
object
Payload for upserting a Pack permission.
2 properties
2 required
GroupPrincipal
object
3 properties
3 required
PackLogDetails
Details for a Pack log.
DocPackConnectionReadAccess
string
Who in the doc has access to read data using the connection.
ExactPermissionCount
object
Exact count of permissions.
2 properties
2 required
PackConnectionMultiHeaderMetadata
object
3 properties
3 required
PackConnectionOauth2ClientCredentialsMetadata
object
4 properties
4 required
PackConnectionMultiHeaderPatch
object
2 properties
1 required
PackListing
object
A Pack listing.
30 properties
12 required
DomainPrincipal
object
2 properties
2 required
Maker
object
Info about the maker
7 properties
2 required
PackPermission
object
Metadata about a Pack permission.
3 properties
3 required
GroupedPackAuthLog
object
Grouped logs of the Pack's auth requests.
3 properties
3 required
PackConnectionAwsAssumeRolePatch
object
3 properties
1 required
PackListingDraftData
object
Draft listing data for a Pack. All fields are optional.
15 properties
PackFeaturedDoc
object
A Pack's featured doc.
4 properties
2 required
PackWorkspacePrincipal
object
2 properties
2 required
UpdatePackRequest
object
Payload for updating a Pack.
16 properties
PackInvitationList
object
List of Pack invitations.
3 properties
1 required
PackAgentRuntimeLogDetails
object
Details for Pack agent runtime logs
3 properties
1 required
PackConnectionHttpBasicPatch
object
3 properties
1 required
UpdatePackInvitationResponse
object
Confirmation of successfully updating a Pack invitation.
PackGroupPrincipal
object
3 properties
2 required
AccessType
string
Type of access.
PackSystemConnectionMetadata
Metadata of a Pack system connection.
PackVersion
object
Details about a Pack version.
8 properties
5 required
PackPlanCurrency
string
Currency needed to subscribe to the Pack.
GroupedPackLogsList
object
List of grouped Pack logs.
4 properties
2 required
DeletePackMakerResponse
object
Confirmation of successfully deleting a Pack maker.
UploadPackAssetRequest
object
Payload for a Pack asset upload.
4 properties
4 required
User
object
Info about the user who initiated an action.
3 properties
3 required
CreatePackRequest
object
Payload for creating a Pack.
4 properties
PackConnectionAwsAssumeRoleCredentials
object
3 properties
3 required
PackSourceCode
object
Details about a Pack's source code.
2 properties
2 required
PackReviewAdditionalInformation
object
Additional information about the Pack review
4 properties
PackReleaseList
object
List of Pack releases.
3 properties
1 required
CancelPackReviewResponse
object
Response confirming the Pack review was canceled
PermissionsSummary
object
Summary of permissions.
5 properties
5 required
PackConnectionMultiHeaderCredentials
object
2 properties
2 required
UpdatePackFeaturedDocsResponse
object
Confirmation of successful Pack featured docs update.
PackListingsSortBy
string
Determines how the Pack listings returned are sorted.
GetPackListingDraftResponse
object
Response containing the Pack listing draft
2 properties
PackListingDetail
object
A detailed Pack listing.
34 properties
14 required
PackDiscoverability
string
Widest principal a Pack is available to.
ListPackReviewsResponse
object
Response containing Pack reviews
3 properties
1 required
MonthlyDocMakerPackPlanPricing
object
Pricing used when workspaces can subscribe to the Pack for a monthly cost per Doc Maker.
3 properties
3 required
PackNomosOrganizationPrincipal
object
2 properties
2 required
PackIngestionLifecycleLog
object
Pack log generated by an executing ingestion.
4 properties
4 required
UserSummary
object
Summary about the user.
4 properties
3 required
CreatePackVersionRequest
object
Payload for Pack version upload complete.
3 properties
HandlePackInvitationRequest
object
Payload for handling a Pack invitation (accept or reject).
1 property
1 required
PackInvocationLogDetails
object
Details for Pack invocation logs
7 properties
1 required
PackAgentRuntimeLog
object
Pack log generated by an executing agent runtime.
10 properties
3 required
PackConnectionHeaderCredentials
object
2 properties
2 required
DeletePackCategoryResponse
object
Confirmation of successfully deleting a Pack category.
PackImageFile
object
A Pack image file.
5 properties
3 required
FeatureSet_2
string
Only relevant for original Superhuman Packs.
AddPackCategoryRequest
object
Payload for adding a Pack Category.
1 property
1 required
IngestionParentItem
object
An ingestion parent item and its execution state (either full or incremental).
12 properties
8 required
PackPermissionList
object
List of Pack permissions.
2 properties
2 required
PackUserAccess
object
The access capabilities the current user has for this Pack.
9 properties
7 required
PackFeaturedDocsResponse
object
List of a Pack's featured docs.
1 property
1 required
PackReview
object
A Pack review submission
8 properties
5 required
BundledPackPlan
object
The Pack plan to show the Pack can be accessed if the workspace is at least the given tier.
4 properties
4 required
FeatureSet
string
Pricing plan associated with a workspace.
DocPackConnectionWriteAccess
string
Who in the doc has access to perform actions using the connection.
PackSourceCodeInfo
object
Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete.
1 property
1 required
UpdatePackReleaseRequest
object
Payload for updating a new Pack release.
1 property
AddPackCategoryResponse
object
Confirmation of successfully adding a Pack category.
PackListingDraftInputData
object
Input data for creating or updating a Pack listing draft. Images only require assetId and filename; the server resolves the full image URL.
15 properties
FeaturedDocStatus
string
Status of featured doc in Pack listing.
IngestionExecutionType
string
Type of an ingestion batch execution.
PackConnectionAwsAssumeRoleMetadata
object
4 properties
4 required
PackConnectionHttpBasicCredentials
object
3 properties
2 required
PackSummary
object
Summary of a Pack.
20 properties
6 required
Permission_2
object
A specific permission granted to a principal.
3 properties
3 required
HandlePackInvitationResponse
object
Confirmation of successfully handling a Pack invitation.
1 property
PackConnectionCustomPatch
object
2 properties
1 required
IngestionParentItemsList
object
List of Ingestion Parent Items.
2 properties
1 required
PackInvitationWithPackList
object
List of Pack invitations with Pack metadata.
3 properties
1 required
PackRelease
object
Details about a Pack release.
6 properties
6 required
MinPermissionCount
object
Minimum count of permissions.
2 properties
2 required
PackReviewStatus
string
The status of a Pack review
UpsertPackListingDraftResponse
object
Response containing the upserted Pack listing draft
3 properties
3 required
ImageFileForUpdatePackRequest
object
Information about an image file for an update Pack request.
3 properties
2 required
Principal
Metadata about a principal.
PackPrincipal
Metadata about a Pack principal.
PackConnectionUrlParamMetadata
object
4 properties
4 required
DeletePackInvitationResponse
object
Confirmation of successfully deleting a Pack invitation.
PackOauthConfigMetadata
object
The Pack OAuth configuration metadata.
8 properties
5 required
PackInvitationWithPack
object
Pack invitation with Pack metadata.
4 properties
4 required
PackCustomLog
object
Pack log generated by developer's custom logging with context.logger.
4 properties
4 required
NextPageToken
string
If specified, an opaque token used to fetch the next page of results.
MakerSummary
object
Summary about a maker
6 properties
1 required
PackConnectionGoogleServiceAccountPatch
object
2 properties
1 required
ListPackCategoriesResponse
object
Confirmation of successfully retrieving Pack categories.
1 property
1 required
PackGlobalPrincipal
object
1 property
1 required
FolderReference
object
Reference to a Superhuman Docs folder.
4 properties
3 required
SetPackOauthConfigRequest
object
Request to set the Pack OAuth configuration.
3 properties
PackConnectionHeaderMetadata
object
4 properties
3 required
PackConfigurationEntry
object
Basic details about a configuration that can be used in conjunction with a Pack
3 properties
2 required
PackIngestionDebugLog
object
Pack log generated by an executing ingestion. Contains metadata helpful for debugging
4 properties
4 required
UpdatePackInvitationRequest
object
Payload for updating a Pack invitation.
1 property
1 required
PackGrammarlyInstitutionPrincipal
object
2 properties
2 required
ParameterSetting
object
Setting for a specific parameter
2 properties
2 required
Pack_2
object
Details about a Pack.
24 properties
6 required
InternalAccessPrincipal
object
2 properties
2 required
PackConnectionUrlParamCredentials
object
2 properties
2 required
PackListingInstallContextType
string
Type of context in which a Pack is being installed.
PackFetcherLogDetails
object
Details for Pack fetcher logs
3 properties
2 required
PackConnectionHttpBasicMetadata
object
3 properties
1 required
IngestionChildExecutionType
string
Type of an ingestion childexecution.
PermissionCount
Count of permissions.
PackInvitation
object
Metadata about a Pack invitation.
7 properties
7 required
DeletePackPermissionResponse
object
Confirmation of successfully deleting a Pack permission.
PackAuthLog
object
System logs of Pack authentication requests.
5 properties
3 required
PackOrganizationAccessForCodaBrain
object
Describes restrictions that a user's organization has placed on a Pack for Coda Brain ingestions
5 properties
3 required
IngestionStatus
string
Status of the ingestion execution.
nextPageToken
string
If specified, an opaque token used to fetch the next page of results.
AddPackMakerResponse
object
Confirmation of successfully adding a Pack maker.
UpdatePackFeaturedDocsRequest
object
Payload for updating featured docs for a Pack.
1 property
1 required
IngestionTableSetting
object
Ingestion settings for a specific table
3 properties
PackConnectionOauth2ClientCredentialsPatch
object
3 properties
1 required
DocPackConnectionList
object
List of connections linked to docs.
4 properties
2 required
PackConnectionOauth2ClientCredentials
object
3 properties
3 required
PackAssetUploadCompleteResponse
object
Response for noting a Pack asset upload is complete.
2 properties
2 required
PackFetcherLog
object
System logs of Pack calls to context.fetcher.
9 properties
2 required
CreatePackInvitationRequest
object
Payload for creating a Pack invitation.
2 properties
2 required
IngestionBatchExecutionsList
object
List of Ingestion Batch Executions.
2 properties
1 required
AddPackMakerRequest
object
Payload for adding a Pack maker.
1 property
1 required
DocPackConnection
object
Metadata for a Packs connection linked to a doc.
9 properties
9 required
PackConnectionAwsAccessKeyMetadata
object
4 properties
4 required
PackListingList
object
A list of Pack listings.
3 properties
1 required
PackLogContext
object
Logging context that comes with a Pack log.
32 properties
11 required
CreatePackInvitationResponse
object
Confirmation of successfully creating a Pack invitation.
1 property
1 required
nextPageLink
string
If specified, a link that can be used to fetch the next page of results.
Permission
object
A specific permission granted to a principal.
4 properties
4 required
GroupedPackInvocationLog
object
Grouped logs of the invocations of the Pack.
3 properties
3 required
SortDirection
string
Direction of a sort for a table or view.
PackLogRequestType
string
The context request type where a Pack log is generated.
IngestionBatchExecution
object
An ingestion batch execution.
19 properties
10 required
PackOrganizationAccessForDocs
object
Describes restrictions that a user's organization has placed on a Pack
9 properties
3 required
GetNextPackVersionRequest
object
Payload for getting the next version of a Pack.
2 properties
1 required
PackSourceCodeUploadCompleteRequest
object
Payload for noting a Pack source code upload is complete.
2 properties
2 required
PackInternalLog
object
Superhuman Docs internal logs from the Packs infrastructure. Only visible to Superhuman employees.
4 properties
4 required
PackAccessTypes
array
Access types for a Pack.
Pack
object
Info about a Pack.
3 properties
3 required
PackConnectionAwsAccessKeyPatch
object
3 properties
1 required
PackSystemConnectionCredentials
Credentials of a Pack connection.
UploadPackSourceCodeRequest
object
Payload for a Pack asset upload.
3 properties
2 required
PackUserPrincipal
object
2 properties
2 required
PackVersionList
object
List of Pack versions.
4 properties
2 required
PackSourceCodeVisibility
string
Visibility of a Pack's source code.
ValidationError
object
Detail about why a particular field failed request validation.
2 properties
2 required
PackSourceCodeUploadInfo
object
Information indicating where to upload the Pack source code, and an endpoint to mark the upload as complete.
3 properties
3 required
PackCategoryType
string
The category of a Pack.
AddPackPermissionResponse
object
Confirmation of successfully upserting a Pack permission.
1 property
1 required
CreatePackReleaseRequest
object
Payload for creating a new Pack release.
2 properties
1 required
PackConnectionCustomCredentials
object
2 properties
2 required
PackMcpLog
object
Pack log generated by an MCP (Model Context Protocol) operation.
4 properties
2 required
PackFeaturedDocRequestItem
object
Item representing a featured doc in the update Pack featured docs request.
2 properties
1 required
AnyonePrincipal
object
1 property
1 required
PackConnectionUrlParamPatch
object
2 properties
1 required
PackListingAdditionalInformation
object
Additional information saved with the Pack listing draft
4 properties
GetPackConfigurationJsonSchemaResponse
object
JSON schema response.
IngestionPackReleaseChannel
string
Live or Latest version of Pack
DocumentAnalytics
object
Metrics for a doc.
5 properties
3 required
PublishingCategory
object
Info about a publishing category
3 properties
2 required
PackConnectionGoogleServiceAccountMetadata
object
2 properties
2 required
CreatePackReviewResponse
object
Response containing created review information
1 property
1 required
FreePackPlanPricing
object
Pricing used when workspaces can subscribe to the Pack for free.
1 property
1 required
PackSummaryList
object
List of Pack summaries.
3 properties
1 required
NextPageLink
string
If specified, a link that can be used to fetch the next page of results.
BundledPackPlanPricing
object
Pricing used when workspaces have access to the Pack for free if their workspace is at least the given tier.
2 properties
2 required
CreatePackReviewRequest
object
Request to create a Pack review
2 properties
DeletePackListingDraftResponse
object
Response after deleting a Pack listing draft
ListPackMakersResponse
object
Confirmation of successfully retrieving Pack makers.
1 property
1 required
PatchPackSystemConnectionRequest
The request to patch Pack system connection credentials.
DocSearchHit
object
Details on where the search query appeared in the doc.
2 properties
2 required
RegisterPackVersionRequest
object
Payload for registering a Pack version.
1 property
1 required
PackVersionUploadInfo
object
Information indicating where to upload the Pack version definition.
2 properties
2 required
DeletePackResponse
object
Confirmation of successful Pack deletion.
PackConnectionHeaderPatch
object
2 properties
1 required
Workspace
object
Info about a Superhuman Docs workspace.
9 properties
3 required
Principal_2
Metadata about a principal.
PackRateLimit
object
Rate limit in Pack settings.
2 properties
2 required
IngestionLimitSettings
object
Limits for a Pack-driven ingestion
3 properties
2 required
NextPackVersionInfo
object
Information indicating the next Pack version definition.
3 properties
3 required
PackSourceCodeUploadCompleteResponse
object
Response for noting a Pack source code upload is complete.
1 property
1 required
PackAssetUploadInfo
object
Information indicating where to upload the Pack asset, and an endpoint to mark the upload as complete.
3 properties
3 required
PackLogsList
object
List of Pack logs.
3 properties
1 required
Doc
object
Info about a document.
23 properties
8 required
EmailPrincipal
object
2 properties
2 required
PackConnectionAwsAccessKeyCredentials
object
3 properties
3 required
PackLog
A record of Pack log.
PaidFeatureSet
string
Workspace feature set excluding free.
CreatePackResponse
object
Info about a Pack that was just created.
1 property
1 required
PackConnectionGoogleServiceAccountCredentials
object
2 properties
2 required
WorkspacePrincipal
object
2 properties
2 required
StandardPackPlan
object
The Pack plan to show the Pack can be subscribed to at a monthly cost per Doc Maker or for free.
4 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coda Project publishes across the network.